siyuan 1.1.6 → 1.1.7

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v1.1.8 2026
+
+## v1.1.7 2025-12-23
+
+* [Provide plugins rendering interfaces for code blocks, formula blocks, etc](https://github.com/siyuan-note/siyuan/issues/16586)
+
 ## v1.1.6 2025-12-02
 
 * [Synchronize config, constants, and protyle](https://github.com/siyuan-note/petal/issues/42)

package/package.json

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

package/types/index.d.ts

@@ -40,7 +40,24 @@ export * as platformUtils from "./protyle/util/compatibility";
 
 
 type TDockPosition = "Left" | "Right" | "Bottom"
-
+type TAVView = "table" | "gallery" | "kanban"
+type TAVFilterOperator =
+    "="
+    | "!="
+    | ">"
+    | ">="
+    | "<"
+    | "<="
+    | "Contains"
+    | "Does not contains"
+    | "Is empty"
+    | "Is not empty"
+    | "Starts with"
+    | "Ends with"
+    | "Is between"
+    | "Is relative to today"
+    | "Is true"
+    | "Is false"
 export type TAVCol =
     "text"
     | "date"
@@ -61,11 +78,11 @@ export type TAVCol =
     | "lineNumber"
 
 interface ILayoutOptions {
-    direction?: Config.TUILayoutDirection
-    size?: string
-    resize?: Config.TUILayoutDirection
-    type?: Config.TUILayoutType
-    element?: HTMLElement
+    direction?: Config.TUILayoutDirection;
+    size?: string;
+    resize?: Config.TUILayoutDirection;
+    type?: Config.TUILayoutType;
+    element?: HTMLElement;
 }
 
 interface IOperationSrcs {
@@ -75,15 +92,15 @@ interface IOperationSrcs {
 }
 
 interface INotebook {
-    name: string
-    id: string
-    closed: boolean
-    icon: string
-    sort: number
+    name: string;
+    id: string;
+    closed: boolean;
+    icon: string;
+    sort: number;
     dueFlashcardCount?: string;
     newFlashcardCount?: string;
     flashcardCount?: string;
-    sortMode: number
+    sortMode: number;
 }
 
 interface IEmojiItem {
@@ -122,6 +139,230 @@ interface IBackStack {
     zoomId?: string
 }
 
+export interface IAV {
+    id: string;
+    name: string;
+    view: IAVTable | IAVGallery;
+    viewID: string;
+    viewType: TAVView;
+    views: IAVView[];
+    isMirror?: boolean;
+}
+
+interface IAVView {
+    name: string;
+    desc: string;
+    id: string;
+    type: TAVView;
+    icon: string;
+    hideAttrViewName: boolean;
+    pageSize: number;
+    showIcon: boolean;
+    wrapField: boolean;
+    groupHidden?: number,  // 0：显示，1：空白隐藏，2：手动隐藏
+    groupFolded?: boolean,
+    filters: IAVFilter[],
+    sorts: IAVSort[],
+    groups: IAVView[]
+    group: IAVGroup
+    groupKey: IAVColumn
+    groupValue: IAVCellValue
+}
+
+interface IAVTable extends IAVView {
+    columns: IAVColumn[],
+    rows: IAVRow[],
+    rowCount: number,
+}
+
+interface IAVGallery 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,
+}
+
+interface IAVFilter {
+    column: string,
+    operator: TAVFilterOperator,
+    quantifier?: string,
+    value: IAVCellValue,
+    relativeDate?: IAVRelativeDate
+    relativeDate2?: IAVRelativeDate
+}
+
+interface IAVRelativeDate {
+    count: number;   // 数量
+    unit: number;    // 单位：0: 天、1: 周、2: 月、3: 年
+    direction: number;   // 方向：-1: 前、0: 现在、1: 后
+}
+
+interface IAVGroup {
+    field: string,
+    method?: number //  0: 按值分组、1: 按数字范围分组、2: 按相对日期分组、3: 按天日期分组、4: 按周日期分组、5: 按月日期分组、6: 按年日期分组
+    range?: {
+        numStart: number // 数字范围起始值 0
+        numEnd: number   // 数字范围结束值 1000
+        numStep: number  // 数字范围步长 100
+    }
+    hideEmpty?: boolean
+    order?: number  // 升序: 0(默认), 降序: 1, 手动排序: 2, 按选项排序: 3
+}
+
+interface IAVSort {
+    column: string,
+    order: "ASC" | "DESC"
+}
+
+interface IAVColumn {
+    width: string,
+    icon: string,
+    id: string,
+    name: string,
+    desc: string,
+    wrap: boolean,
+    pin: boolean,
+    hidden: boolean,
+    type: TAVCol,
+    numberFormat: string,
+    template: string,
+    calc: IAVCalc,
+    updated?: {
+        includeTime: boolean
+    }
+    created?: {
+        includeTime: boolean
+    }
+    date?: {
+        autoFillNow: boolean,
+        fillSpecificTime: boolean,
+    }
+    // 选项列表
+    options?: {
+        name: string,
+        color: string,
+        desc?: string,
+    }[],
+    relation?: IAVColumnRelation,
+    rollup?: IAVCellRollupValue
+}
+
+interface IAVRow {
+    id: string,
+    cells: IAVCell[]
+}
+
+interface IAVGalleryItem {
+    coverURL?: string;
+    coverContent?: string;
+    id: string;
+    values: IAVCell[];
+}
+
+interface IAVCell {
+    id: string,
+    color: string,
+    bgColor: string,
+    value: IAVCellValue,
+    valueType: TAVCol,
+}
+
+interface IAVCellValue {
+    keyID?: string,
+    id?: string,
+    blockID?: string // 为 row id
+    type: TAVCol,
+    isDetached?: boolean,
+    text?: {
+        content: string
+    },
+    number?: {
+        content?: number,
+        isNotEmpty: boolean,
+        format?: string,
+        formattedContent?: string
+    },
+    mSelect?: IAVCellSelectValue[]
+    mAsset?: IAVCellAssetValue[]
+    block?: {
+        content: string,
+        id?: string,
+        icon?: string
+    }
+    url?: {
+        content: string
+    }
+    phone?: {
+        content: string
+    }
+    email?: {
+        content: string
+    }
+    template?: {
+        content: string
+    },
+    checkbox?: {
+        checked: boolean,
+        content?: string, // gallery 中显示 https://github.com/siyuan-note/siyuan/issues/15389
+    }
+    relation?: IAVCellRelationValue
+    rollup?: {
+        contents?: IAVCellValue[]
+    }
+    date?: IAVCellDateValue
+    created?: IAVCellDateValue
+    updated?: IAVCellDateValue
+}
+
+interface IAVCellRelationValue {
+    blockIDs: string[];
+    contents?: IAVCellValue[];
+}
+
+interface IAVCellDateValue {
+    content?: number,
+    isNotEmpty?: boolean
+    content2?: number,
+    isNotEmpty2?: boolean
+    hasEndDate?: boolean
+    formattedContent?: string,
+    isNotTime?: boolean // 默认 true
+}
+
+interface IAVCellSelectValue {
+    content: string,
+    color: string
+}
+
+interface IAVCellAssetValue {
+    content: string,
+    name: string,
+    type: "file" | "image"
+}
+
+interface IAVColumnRelation {
+    avID?: string;
+    backKeyID?: string;
+    isTwoWay?: boolean;
+}
+
+interface IAVCellRollupValue {
+    relationKeyID?: string;  // 关联列 ID
+    keyID?: string;
+    calc?: IAVCalc;
+}
+
+interface IAVCalc {
+    operator?: string,
+    result?: IAVCellValue
+}
+
 export interface IOperation {
     action: TOperation, // move， delete 不需要传 data
     id?: string,
@@ -450,7 +691,7 @@ export declare class subMenu {
 
 export declare class App {
     plugins: Plugin[];
-    appId: string
+    appId: string;
 }
 
 export declare class Menus {

package/types/protyle.d.ts

@@ -1,7 +1,13 @@
 import {
-    App, Config, Editor,
+    App,
+    Config,
+    Editor,
+    IAV,
     IObject,
-    IOperation, IPosition, IWebSocketData, Menu,
+    IOperation,
+    IPosition,
+    IWebSocketData,
+    Menu,
 } from "./../siyuan";
 import {Model} from "./layout/Model";
 
@@ -290,6 +296,75 @@ export class Protyle {
     public renderAVAttribute(element: HTMLElement, id: string, cb?: (element: HTMLElement) => void): void
 }
 
+export class ProtyleMethod {
+    /**
+     * @description 使用 graphviz 进行渲染
+     * @param {string} [cdn=Constants.PROTYLE_CDN]
+     */
+    public static graphvizRender(element: Element, cdn?: string): void
+
+    /**
+     * @description 为 element 中的代码块进行高亮渲染
+     * @param {string} [cdn=Constants.PROTYLE_CDN]
+     * @param {number} [zoom=1]
+     */
+    public static highlightRender(element: Element, cdn?: string, zoom?: number): void
+
+    /**
+     * @description 对数学公式进行渲染
+     * @param {string} [cdn=Constants.PROTYLE_CDN]
+     * @param {boolean} [maxWidth=false]
+     */
+    public static mathRender(element: Element, cdn?: string, maxWidth?: boolean): void;
+
+    /**
+     * @description mermaid.js 渲染，支持流程图/时序图/甘特图渲染等
+     * @param {string} [cdn=Constants.PROTYLE_CDN]
+     */
+    public static mermaidRender(element: Element, cdn?: string): void;
+
+    /**
+     * @description flowchart.js 渲染
+     * @param {string} [cdn=Constants.PROTYLE_CDN]
+     */
+    public static flowchartRender(element: Element, cdn?: string): void;
+
+    /**
+     * @description 图表渲染
+     * @param {string} [cdn=Constants.PROTYLE_CDN]
+     */
+    public static chartRender(element: Element, cdn?: string): void;
+
+    /**
+     * @description 五线谱渲染
+     * @param {string} [cdn=Constants.PROTYLE_CDN]
+     */
+    public static abcRender(element: Element, cdn?: string): void;
+
+    /**
+     * @description 脑图渲染
+     * @param {string} [cdn=Constants.PROTYLE_CDN]
+     */
+    public static mindmapRender(element: Element, cdn?: string): void;
+
+    /**
+     * @description UML 渲染
+     * @param {string} [cdn=Constants.PROTYLE_CDN]
+     */
+    public static plantumlRender(element: Element, cdn?: string): void;
+
+    /**
+     * @description 数据库渲染
+     * @param {boolean} [renderAll=true]
+     */
+    public static avRender(element: Element, protyle: IProtyle, cb?: (data: IAV) => void, renderAll?: boolean, avData?: IAV): Promise<void>;
+
+    /**
+     * @description html 渲染
+     */
+    public static htmlRender(element: Element): void;
+}
+
 interface ILuteNode {
     TokensStr: () => string;
     __internal_object__: {