siyuan 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## v1.0.6 2024-11
+
+## v1.0.5 2024-11-05
+
+* [Add `renderElement` and `blockElement` for `open-noneditableblock`](https://github.com/siyuan-note/siyuan/issues/12955)
+* [Add plugin util `platformUtils`](https://github.com/siyuan-note/siyuan/issues/12930)
+* [Added reading local files to `on-paste`](https://github.com/siyuan-note/siyuan/issues/12917)
+* [Add plugin function `getAllEditor`](https://github.com/siyuan-note/siyuan/issues/12884)
+* [Add plugin function `getModelByDockType`](https://github.com/siyuan-note/siyuan/issues/11782)
+* [Replace `any` in IProtyle with the corresponding type](https://github.com/siyuan-note/petal/issues/34)
+
+## v1.0.4 2024-10-15
+
+* [Add plugin method `exitSiYuan`](https://github.com/siyuan-note/siyuan/pull/12767)
+
 ## v1.0.3 2024-09-27
 
 * [Add plugin event bus `opened-notebook` & `closed-notebook`](https://github.com/siyuan-note/siyuan/issues/11974)

package/package.json

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

package/siyuan.d.ts

@@ -1,24 +1,41 @@
-export * from "./types";
+import {
+    IGetDocInfo,
+    IGetTreeStat,
+    IMenuBaseDetail,
+    Config,
+    Custom,
+    Dock,
+    IMenu,
+    IObject,
+    IPosition,
+    ISiyuan,
+    IWebSocketData,
+    IProtyle,
+    Lute,
+    Protyle,
+    Toolbar,
+    IProtyleOptions,
+    TProtyleAction,
+    subMenu,
+    App,
+    Files,
+    Tab, Model,
+} from "./types";
 
-import {IProtyle, Lute, Protyle, Toolbar, IProtyleOption, TProtyleAction} from "./types/protyle";
-import {Config} from "./types/config";
-import {IMenuBaseDetail} from "./types/events";
-import {IGetDocInfo, IGetTreeStat} from "./types/response";
+export * from "./types";
 
 declare global {
     export interface Window extends Global {
     }
 }
 
-export type TEventBus = keyof IEventBusMap
+export type TDock = "file" | "outline" | "inbox" | "bookmark" | "tag" | "graph" | "globalGraph" | "backlink"
 
-export type TTurnIntoOne = "BlocksMergeSuperBlock" | "Blocks2ULs" | "Blocks2OLs" | "Blocks2TLs" | "Blocks2Blockquote"
-
-export type TTurnIntoOneSub = "row" | "col"
+export type TCardType = "doc" | "notebook" | "all"
 
-export type TTurnInto = "Blocks2Ps" | "Blocks2Hs"
+export type TEventBus = keyof IEventBusMap
 
-export type TCardType = "doc" | "notebook" | "all"
+export type TPluginDockPosition = "LeftTop" | "LeftBottom" | "RightTop" | "RightBottom" | "BottomLeft" | "BottomRight"
 
 export type TOperation =
     "insert"
@@ -52,68 +69,18 @@ export type TOperation =
     | "setAttrViewColCalc"
     | "updateAttrViewColNumberFormat"
 
-export type TAVCol =
-    "text"
-    | "date"
-    | "number"
-    | "relation"
-    | "rollup"
-    | "select"
-    | "block"
-    | "mSelect"
-    | "url"
-    | "email"
-    | "phone"
-
-export interface ISiyuan {
-    config: Config.IConf;
-}
-
 export interface Global {
     Lute: typeof Lute;
     siyuan: ISiyuan;
 }
 
-interface IKeymapItem {
-    default: string,
-    custom: string
-}
-
-export interface IKeymap {
-    plugin: {
-        [key: string]: {
-            [key: string]: IKeymapItem
-        }
-    }
-    general: {
-        [key: string]: IKeymapItem
-    }
-    editor: {
-        general: {
-            [key: string]: IKeymapItem
-        }
-        insert: {
-            [key: string]: IKeymapItem
-        }
-        heading: {
-            [key: string]: IKeymapItem
-        }
-        list: {
-            [key: string]: IKeymapItem
-        }
-        table: {
-            [key: string]: IKeymapItem
-        }
-    }
-}
-
 export interface IEventBusMap {
     "click-flashcard-action": {
         card: ICard,
         type: string,   // 1 - 重来；2 - 困难；3 - 良好；4 - 简单；-1 - 显示答案；-2 - 上一个 ；-3 - 跳过
     };
     "click-blockicon": {
-        menu: EventMenu,
+        menu: subMenu,
         protyle: IProtyle,
         blockElements: HTMLElement[],
     };
@@ -122,19 +89,20 @@ export interface IEventBusMap {
         event: MouseEvent,
     };
     "click-editortitleicon": {
-        menu: EventMenu,
+        menu: subMenu,
         protyle: IProtyle,
         data: IGetDocInfo,
     };
     "click-pdf": {
         event: MouseEvent,
     };
+    "closed-notebook": IWebSocketData;
     "destroy-protyle": {
         protyle: IProtyle,
     };
     "input-search": {
         protyle: Protyle,
-        config: ISearchOption,
+        config: Config.IUILayoutTabSearchConfig,
         searchElement: HTMLInputElement,
     };
     "loaded-protyle-dynamic": {
@@ -144,13 +112,14 @@ export interface IEventBusMap {
     "loaded-protyle-static": {
         protyle: IProtyle,
     };
+    "lock-screen": void;
     "switch-protyle": {
         protyle: IProtyle,
     };
     "open-menu-av": IMenuBaseDetail & { selectRowElements: HTMLElement[] };
     "open-menu-blockref": IMenuBaseDetail;
     "open-menu-breadcrumbmore": {
-        menu: EventMenu,
+        menu: subMenu,
         protyle: IProtyle,
         data: IGetTreeStat,
     };
@@ -160,18 +129,20 @@ export interface IEventBusMap {
     "open-menu-link": IMenuBaseDetail;
     "open-menu-tag": IMenuBaseDetail;
     "open-menu-doctree": {
-        menu: EventMenu,
+        menu: subMenu,
         elements: NodeListOf<HTMLElement>,
         type: "doc" | "docs" | "notebook",
     };
     "open-menu-inbox": {
-        menu: EventMenu,
+        menu: subMenu,
         element: HTMLElement,
         ids: string[],
     };
     "open-noneditableblock": {
         protyle: IProtyle,
         toolbar: Toolbar,
+        blockElement: HTMLElement,
+        renderElement: HTMLElement,
     };
     "open-siyuan-url-block": {
         url: string,
@@ -183,170 +154,35 @@ export interface IEventBusMap {
         url: string,
     };
     "opened-notebook": IWebSocketData;
-    "closed-notebook":IWebSocketData;
     "paste": {
         protyle: IProtyle,
         resolve: new <T>(value: T | PromiseLike<T>) => void,
         textHTML: string,
         textPlain: string,
         siyuanHTML: string,
-        files: FileList | DataTransferItemList;
+        files: FileList | DataTransferItemList | string[]; // 读取本地文件时为 string[]
     }
     "ws-main": IWebSocketData;
     "sync-start": IWebSocketData;
     "sync-end": IWebSocketData;
     "sync-fail": IWebSocketData;
-    "lock-screen": void;
     "mobile-keyboard-show": void;
     "mobile-keyboard-hide": void;
 }
 
-export interface IPosition {
-    x: number;
-    y: number;
-    w?: number;
-    h?: number;
-    isLeft?: boolean;
-}
-
-export interface ITab {
-    id: string;
-    headElement: HTMLElement;
-    panelElement: HTMLElement;
-    model: IModel;
-    title: string;
-    icon: string;
-    docIcon: string;
-    updateTitle: (title: string) => void;
-    pin: () => void;
-    unpin: () => void;
-    setDocIcon: (icon: string) => void;
-    close: () => void;
-}
-
-export interface IModel {
-    ws: WebSocket;
-    app: App;
-    reqId: number;
-    parent: ITab | any;
-
-    send(cmd: string, param: Record<string, unknown>, process?: boolean): void;
-}
-
-export interface ICustomModel extends IModel {
-    tab: ITab;
-    data: any;
-    type: string;
-    element: HTMLElement;
-    editors: Protyle[]; // 系统内部处理快捷键等操作需要用到 https://github.com/siyuan-note/siyuan/issues/11072
-
-    init(): void;
-
-    update?(): void;
-
-    resize?(): void;
-
-    beforeDestroy?(): void;
-
-    destroy?(): void;
-}
-
-export interface IDockModel extends Omit<ICustomModel, "beforeDestroy"> {
-}
-
-export interface ITabModel extends ICustomModel {
-}
-
-export interface IObject {
-    [key: string]: string;
-}
-
-export interface I18N {
-    [key: string]: any;
-}
-
-export interface ILuteNode {
-    TokensStr: () => string;
-    __internal_object__: {
-        Parent: {
-            Type: number,
-        },
-        HeadingLevel: string,
-    };
-}
-
-export interface ISearchOption {
-    page?: number;
-    removed?: boolean;  // 移除后需记录搜索内容 https://github.com/siyuan-note/siyuan/issues/7745
-    name?: string;
-    sort?: number;  //  0：按块类型（默认），1：按创建时间升序，2：按创建时间降序，3：按更新时间升序，4：按更新时间降序，5：按内容顺序（仅在按文档分组时），6：按相关度升序，7：按相关度降序
-    group?: number;  // 0：不分组，1：按文档分组
-    hasReplace?: boolean;
-    method?: number; //  0：文本，1：查询语法，2：SQL，3：正则表达式
-    hPath?: string;
-    idPath?: string[];
-    k: string;
-    r?: string;
-    types?: {
-        mathBlock: boolean,
-        table: boolean,
-        blockquote: boolean,
-        superBlock: boolean,
-        paragraph: boolean,
-        document: boolean,
-        heading: boolean,
-        list: boolean,
-        listItem: boolean,
-        codeBlock: boolean,
-        htmlBlock: boolean,
-        embedBlock: boolean,
-        databaseBlock: boolean,
-    };
-}
-
-export interface IWebSocketData {
-    cmd: string;
-    callback?: string;
-    data: any;
-    msg: string;
-    code: number;
-    sid: string;
-}
-
 export interface IPluginDockTab {
-    position: "LeftTop" | "LeftBottom" | "RightTop" | "RightBottom" | "BottomLeft" | "BottomRight";
-    size: {
-        width: number,
-        height: number,
-    };
-    icon: string;
-    hotkey?: string;
-    title: string;
-    index?: number;
-    show?: boolean;
-}
-
-export interface IMenuItemOption {
-    iconClass?: string;
-    label?: string;
-    click?: (element: HTMLElement, event: MouseEvent) => boolean | void | Promise<boolean | void>;
-    type?: "separator" | "submenu" | "readonly";
-    accelerator?: string;
-    action?: string;
-    id?: string;
-    submenu?: IMenuItemOption[];
-    disabled?: boolean;
-    icon?: string;
-    iconHTML?: string;
-    current?: boolean;
-    bind?: (element: HTMLElement) => void;
-    index?: number;
-    element?: HTMLElement;
+    position: TPluginDockPosition,
+    size: Config.IUILayoutDockPanelSize,
+    icon: string,
+    hotkey?: string,
+    title: string,
+    index?: number
+    show?: boolean
 }
 
-export interface ICommandOption {
-    langKey: string // 用于区分不同快捷键的 key
-    langText?: string // 快捷键功能描述文本
+export interface ICommand {
+    langKey: string, // 用于区分不同快捷键的 key, 同时作为 i18n 的字段名
+    langText?: string, // 显示的文本, 指定后不再使用 langKey 对应的 i18n 文本
     /**
      * 目前需使用 MacOS 符号标识，顺序按照 ⌥⇧⌘，入 ⌥⇧⌘A
      * "Ctrl": "⌘",
@@ -359,33 +195,11 @@ export interface ICommandOption {
      */
     hotkey: string,
     customHotkey?: string,
-    callback?: () => void // 其余回调存在时将不会触
+    callback?: () => void   // 其余回调存在时将不会触
     globalCallback?: () => void // 焦点不在应用内时执行的回调
-    fileTreeCallback?: (file: any) => void // 焦点在文档树上时执行的回调
-    editorCallback?: (protyle: any) => void // 焦点在编辑器上时执行的回调
-    dockCallback?: (element: HTMLElement) => void // 焦点在 dock 上时执行的回调
-}
-
-export interface IOperation {
-    action: TOperation; // move， delete 不需要传 data
-    id?: string;
-    isTwoWay?: boolean; // 是否双向关联
-    backRelationKeyID?: string; // 双向关联的目标关联列 ID
-    avID?: string; // av
-    format?: string; // updateAttrViewColNumberFormat 专享
-    keyID?: string; // updateAttrViewCell 专享
-    rowID?: string; // updateAttrViewCell 专享
-    data?: any; // updateAttr 时为  { old: IObject, new: IObject }, updateAttrViewCell 时为 {TAVCol: {content: string}}
-    parentID?: string;
-    previousID?: string;
-    retData?: any;
-    nextID?: string; // insert 专享
-    isDetached?: boolean; // insertAttrViewBlock 专享
-    srcIDs?: string[]; // insertAttrViewBlock 专享
-    name?: string; // addAttrViewCol 专享
-    type?: TAVCol; // addAttrViewCol 专享
-    deckID?: string; // add/removeFlashcards 专享
-    blockIDs?: string[]; // add/removeFlashcards 专享
+    fileTreeCallback?: (file: Files) => void // 焦点在文档树上时执行的回调
+    editorCallback?: (protyle: IProtyle) => void     // 焦点在编辑器上时执行的回调
+    dockCallback?: (element: HTMLElement) => void    // 焦点在 dock 上时执行的回调
 }
 
 export interface ICard {
@@ -393,6 +207,10 @@ export interface ICard {
     cardID: string
     blockID: string
     nextDues: IObject
+    lapses: number  // 遗忘次数
+    lastReview: number  // 最后复习时间
+    reps: number  // 复习次数
+    state: number   // 卡片状态 0：新卡
 }
 
 export interface ICardData {
@@ -402,6 +220,10 @@ export interface ICardData {
     unreviewedOldCardCount: number
 }
 
+export function adaptHotkey(hotkey: string): string
+
+export function confirm(title: string, text: string, confirmCallback?: (dialog: Dialog) => void, cancelCallback?: (dialog: Dialog) => void): void;
+
 export function fetchPost(url: string, data?: any, callback?: (response: IWebSocketData) => void, headers?: IObject): void;
 
 export function fetchSyncPost(url: string, data?: any): Promise<IWebSocketData>;
@@ -415,13 +237,13 @@ export function openWindow(options: {
     },
     height?: number,
     width?: number,
-    tab?: ITab,
+    tab?: Tab,
     doc?: {
         id: string; // 块 id
     },
 }): void;
 
-export function openMobileFileById(app: App, id: string, action?: string[]): void;
+export function openMobileFileById(app: App, id: string, action?: TProtyleAction[]): void;
 
 export function openTab(options: {
     app: App,
@@ -438,7 +260,7 @@ export function openTab(options: {
     asset?: {
         path: string,
     };
-    search?: ISearchOption;
+    search?: Config.IUILayoutTabSearchConfig;
     card?: {
         type: TCardType,
         id?: string, //  cardType 为 all 时不传，否则传文档或笔记本 id
@@ -454,17 +276,19 @@ export function openTab(options: {
     keepCursor?: boolean; // 是否跳转到新 tab 上
     removeCurrentTab?: boolean; // 在当前页签打开时需移除原有页签
     afterOpen?: () => void; // 打开后回调
-}): Promise<ITab>
+}): Promise<Tab>
 
 export function getFrontend(): "desktop" | "desktop-window" | "mobile" | "browser-desktop" | "browser-mobile";
 
+export function getBackend(): "windows" | "linux" | "darwin" | "docker" | "android" | "ios";
+
 export function lockScreen(app: App): void
 
-export function getBackend(): "windows" | "linux" | "darwin" | "docker" | "android" | "ios";
+export function exitSiYuan(): void
 
-export function adaptHotkey(hotkey: string): string;
+export function getAllEditor(): Protyle[]
 
-export function confirm(title: string, text: string, confirmCallback?: (dialog: Dialog) => void, cancelCallback?: (dialog: Dialog) => void): void;
+export function getModelByDockType(type: TDock | string): Model | any;
 
 /**
  * @param timeout - ms. 0: manual close；-1: always show; 6000: default
@@ -472,19 +296,14 @@ export function confirm(title: string, text: string, confirmCallback?: (dialog:
  */
 export function showMessage(text: string, timeout?: number, type?: "info" | "error", id?: string): void;
 
-export class App {
-    plugins: Plugin[];
-    appId: string
-}
-
 export abstract class Plugin {
     eventBus: EventBus;
-    i18n: I18N;
+    i18n: IObject;
     data: any;
     displayName: string;
     readonly name: string;
     app: App;
-    commands: ICommandOption[];
+    commands: ICommand[];
     setting: Setting;
     protyleSlash: {
         filter: string[],
@@ -492,12 +311,12 @@ export abstract class Plugin {
         id: string,
         callback(protyle: Protyle): void,
     }[];
-    protyleOptions: IProtyleOption;
+    protyleOptions: IProtyleOptions;
 
     constructor(options: {
         app: App,
         name: string,
-        i18n: I18N,
+        i18n: IObject,
     });
 
     onload(): void;
@@ -539,19 +358,19 @@ export abstract class Plugin {
 
     addIcons(svg: string): void;
 
-    getOpenedTab(): { [key: string]: ICustomModel[] };
+    getOpenedTab(): { [key: string]: Custom[] };
 
     /**
      * Must be executed before the synchronous function.
      */
     addTab(options: {
         type: string,
-        beforeDestroy?: (this: ITabModel) => void,
-        destroy?: (this: ITabModel) => void,
-        resize?: (this: ITabModel) => void,
-        update?: (this: ITabModel) => void,
-        init: (this: ITabModel) => void,
-    }): () => ITabModel;
+        beforeDestroy?: (this: Custom) => void,
+        destroy?: (this: Custom) => void,
+        resize?: (this: Custom) => void,
+        update?: (this: Custom) => void,
+        init: (this: Custom) => void,
+    }): () => Custom;
 
     /**
      * Must be executed before the synchronous function.
@@ -560,13 +379,13 @@ export abstract class Plugin {
         config: IPluginDockTab,
         data: any,
         type: string,
-        destroy?: (this: IDockModel) => void,
-        resize?: (this: IDockModel) => void,
-        update?: (this: IDockModel) => void,
-        init: (this: IDockModel, dock: IDockModel) => void,
-    }): { config: IPluginDockTab, model: IDockModel };
+        destroy?: (this: Dock) => void,
+        resize?: (this: Dock) => void,
+        update?: (this: Dock) => void,
+        init: (this: Dock, dock: Dock) => void,
+    }): { config: IPluginDockTab, model: Dock };
 
-    addCommand(options: ICommandOption): void;
+    addCommand(options: ICommand): void;
 
     addFloatLayer(options: {
         ids: string[],
@@ -646,17 +465,19 @@ export class Dialog {
 }
 
 export class Menu {
-    constructor(id?: string, closeCallback?: () => void);
-
+    private menu;
+    isOpen: boolean;
     element: HTMLElement;
 
+    constructor(id?: string, closeCB?: () => void);
+
     showSubMenu(subMenuElement: HTMLElement): void;
 
-    addItem(options: IMenuItemOption): HTMLElement;
+    addItem(option: IMenu): HTMLElement;
 
-    addSeparator(index?: number): void;
+    addSeparator(index?: number, ignore?: boolean): HTMLElement;
 
-    open(options: { x: number, y: number, h?: number, w?: number, isLeft?: boolean }): void;
+    open(options: IPosition): void;
 
     /**
      * @param {string} [position=all]
@@ -665,13 +486,3 @@ export class Menu {
 
     close(): void;
 }
-
-export class EventMenu {
-    public menus: IMenuItemOption[];
-
-    constructor();
-
-    public addSeparator(index?: number): void;
-
-    public addItem(menu: IMenuItemOption): void;
-}

package/types/block/Panel.d.ts

@@ -0,0 +1,27 @@
+import {Protyle} from "../protyle";
+import {App} from "../index";
+
+export declare class BlockPanel {
+    element: HTMLElement;
+    targetElement: HTMLElement;
+    nodeIds: string[];
+    defIds: string[];
+    id: string;
+    private app;
+    x: number;
+    y: number;
+    private isBacklink;
+    editors: Protyle[];
+    constructor(options: {
+        app: App;
+        targetElement?: HTMLElement;
+        nodeIds?: string[];
+        defIds?: string[];
+        isBacklink: boolean;
+        x?: number;
+        y?: number;
+    });
+    private initProtyle;
+    destroy(): void;
+    private render;
+}