siyuan 1.0.4 → 1.0.5

package/types/protyle.d.ts

@@ -1,15 +1,19 @@
 import {
-    App,
-    ILuteNode,
+    App, Config, Editor,
     IObject,
-    IOperation,
-    IPosition,
-    TTurnInto,
-    TTurnIntoOne,
-    TTurnIntoOneSub
+    IOperation, IPosition, IWebSocketData, Menu,
 } from "./../siyuan";
+import {Model} from "./layout/Model";
 
-type TProtyleAction = "cb-get-append" | // 向下滚动加载
+type TTurnIntoOne = "BlocksMergeSuperBlock" | "Blocks2ULs" | "Blocks2OLs" | "Blocks2TLs" | "Blocks2Blockquote"
+
+type TTurnIntoOneSub = "row" | "col"
+
+type TTurnInto = "Blocks2Ps" | "Blocks2Hs"
+
+type THintSource = "search" | "av" | "hint";
+
+export type TProtyleAction = "cb-get-append" | // 向下滚动加载
     "cb-get-before" | // 向上滚动加载
     "cb-get-unchangeid" | // 上下滚动，定位时不修改 blockid
     "cb-get-hl" | // 高亮
@@ -19,189 +23,404 @@ type TProtyleAction = "cb-get-append" | // 向下滚动加载
     "cb-get-all" | // 获取所有块
     "cb-get-backlink" | // 悬浮窗为传递型需展示上下文
     "cb-get-unundo" | // 不需要记录历史
-    "cb-get-scroll" | // 滚动到指定位置
+    "cb-get-scroll" | // 滚动到指定位置，用于直接打开文档，必有 rootID
     "cb-get-context" | // 包含上下文
+    "cb-get-rootscroll" | // 如果为 rootID 就滚动到指定位置，必有 rootID
     "cb-get-html" | // 直接渲染，不需要再 /api/block/getDocInfo，否则搜索表格无法定位
-    "cb-get-history" // 历史渲染
+    "cb-get-history" | // 历史渲染
+    "cb-get-opennew"  // 编辑器只读后新建文件需为临时解锁状态 & https://github.com/siyuan-note/siyuan/issues/12197
+
+export type TEditorMode = "preview" | "wysiwyg"
 
-interface IToolbarItem {
+interface ILuteNode {
+    TokensStr: () => string;
+    __internal_object__: {
+        Parent: {
+            Type: number,
+        },
+        HeadingLevel: string,
+    };
+}
+
+/** @link https://ld246.com/article/1549638745630#options-toolbar */
+interface IMenuItem {
     /** 唯一标示 */
     name: string;
     /** 提示 */
     tip?: string;
+    /** 语言 key */
+    lang?: string;
     /** svg 图标 */
-    icon: string;
+    icon?: string;
     /** 快捷键 */
     hotkey?: string;
-    /** 提示位置 */
-    tipPosition: string;
+    /** 提示的位置 */
+    tipPosition?: string;
+
     click?(protyle: Protyle): void;
 }
 
-export type TEditorMode = "preview" | "wysiwyg"
+interface IBreadcrumb {
+    id: string,
+    name: string,
+    type: string,
+    subType: string,
+    children: []
+}
 
-export interface IProtyleOption {
-    action?: TProtyleAction[];
-    mode?: TEditorMode;
-    toolbar?: Array<string | IToolbarItem>;
-    blockId?: string;
-    key?: string;
-    scrollAttr?: {
-        rootId: string,
-        startId: string,
-        endId: string,
-        scrollTop: number,
-        focusId?: string,
-        focusStart?: number,
-        focusEnd?: number,
-        zoomInId?: string,
-    };
-    defId?: string;
+interface IOperations {
+    doOperations: IOperation[],
+    undoOperations: IOperation[]
+}
+
+interface IHintData {
+    id?: string;
+    html: string;
+    value: string;
+    filter?: string[]
+    focus?: boolean
+}
+
+export interface IProtyleOptions {
+    history?: {
+        created?: string
+        snapshot?: string
+    },
+    backlinkData?: {
+        blockPaths: IBreadcrumb[],
+        dom: string
+        expand: boolean
+    }[],
+    action?: TProtyleAction[],
+    mode?: TEditorMode,
+    blockId?: string
+    rootId?: string
+    key?: string
+    defId?: string
     render?: {
-        background?: boolean,
-        title?: boolean,
-        gutter?: boolean,
-        scroll?: boolean,
-        breadcrumb?: boolean,
-        breadcrumbDocName?: boolean,
-    };
+        background?: boolean
+        title?: boolean
+        gutter?: boolean
+        scroll?: boolean
+        breadcrumb?: boolean
+        breadcrumbDocName?: boolean
+    }
+    /** 内部调试时使用 */
+    _lutePath?: string;
+    /** 是否显示日志。默认值: false */
+    debugger?: boolean;
+    /** 是否启用打字机模式。默认值: false */
     typewriterMode?: boolean;
+    /** 多语言。默认值: 'zh_CN' */
+    lang?: string;
+    /** @link https://ld246.com/article/1549638745630#options-toolbar */
+    toolbar?: Array<string | IMenuItem>;
+    /** @link https://ld246.com/article/1549638745630#options-classes */
+    classes?: {
+        preview?: string;
+    };
 
+    /** 编辑器异步渲染完成后的回调方法 */
     after?(protyle: Protyle): void;
 }
 
 // REF: https://github.com/siyuan-note/siyuan/blob/dev/app/src/types/protyle.d.ts
 export interface IProtyle {
-    getInstance: () => Protyle;
-    app: App;
-    transactionTime: number;
-    id: string;
+    getInstance: () => Protyle,
+    observerLoad?: ResizeObserver,
+    observer?: ResizeObserver,
+    app: App,
+    transactionTime: number,
+    id: string,
+    query?: {
+        key: string,
+        method: number
+        types: Config.IUILayoutTabSearchConfigTypes
+    },
     block: {
-        id?: string;
-        scroll?: boolean;
-        parentID?: string;
-        parent2ID?: string;
-        rootID?: string;
-        showAll?: boolean;
-        mode?: number;
-        blockCount?: number;
-        action?: string[];
-    };
-    disabled: boolean;
-    selectElement?: HTMLElement;
-    ws?: any;
-    notebookId?: string;
-    path?: string;
-    model?: any;
+        id?: string,
+        scroll?: boolean
+        parentID?: string,
+        parent2ID?: string,
+        rootID?: string,
+        showAll?: boolean
+        mode?: number
+        blockCount?: number
+        action?: string[]
+    },
+    disabled: boolean,
+    selectElement?: HTMLElement,
+    ws?: Model,
+    notebookId?: string
+    path?: string
+    model?: Editor,
     updated: boolean;
     element: HTMLElement;
-    scroll?: any;
-    gutter?: any;
-    breadcrumb?: {
-        id: string;
-        element: HTMLElement;
-    };
-    title?: {
-        editElement: HTMLElement;
-        element: HTMLElement;
-    };
-    background?: {
-        element: HTMLElement;
-        ial: Record<string, string>;
-        iconElement: HTMLElement;
-        imgElement: HTMLElement;
-        tagsElement: HTMLElement;
-        transparentData: string;
-    };
-    contentElement?: HTMLElement;
-    options: any;
+    scroll?: Scroll,
+    gutter?: Gutter,
+    breadcrumb?: Breadcrumb,
+    title?: Title,
+    background?: Background,
+    contentElement?: HTMLElement,
+    options: IProtyleOptions;
     lute?: Lute;
-    toolbar?: Toolbar;
-    preview?: any;
-    hint?: any;
-    upload?: any;
-    undo?: any;
-    wysiwyg?: any;
+    toolbar?: Toolbar,
+    preview?: Preview;
+    hint?: Hint;
+    upload?: Upload;
+    undo?: Undo;
+    wysiwyg?: WYSIWYG
 }
 
-export class Protyle {
+declare class Viz {
+    constructor(worker: { worker: Worker });
 
-    public protyle: IProtyle;
+    renderSVGElement: (code: string) => Promise<any>;
+}
 
-    constructor(app: App, element: HTMLElement, options?: IProtyleOption)
+declare class Viewer {
+    public destroyed: boolean;
+
+    constructor(element: Element, options: {
+        title: [number, (image: HTMLImageElement, imageData: IObject) => string],
+        button: boolean,
+        initialViewIndex?: number,
+        transition: boolean,
+        hidden: () => void,
+        toolbar: {
+            zoomIn: boolean,
+            zoomOut: boolean,
+            oneToOne: boolean,
+            reset: boolean,
+            prev: boolean,
+            play: boolean,
+            next: boolean,
+            rotateLeft: boolean,
+            rotateRight: boolean,
+            flipHorizontal: boolean,
+            flipVertical: boolean,
+            close: () => void
+        }
+    })
 
-    isUploading(): boolean
+    public destroy(): void
 
-    destroy(): void
+    public show(): void
+}
 
-    resize(): void
+declare class Breadcrumb {
+    element: HTMLElement;
 
-    reload(focus: boolean): void
+    constructor(protyle: IProtyle);
 
-    /**
-     * @param {boolean} [isBlock=false]
-     * @param {boolean} [useProtyleRange=false]
-     */
-    insert(html: string, isBlock?: boolean, useProtyleRange?: boolean): void
+    toggleExit(hide: boolean): void;
 
-    transaction(doOperations: IOperation[], undoOperations?: IOperation[]): void;
+    showMenu(protyle: IProtyle, position: IPosition): void;
 
-    /**
-     * 多个块转换为一个块
-     * @param {TTurnIntoOneSub} [subType] type 为 "BlocksMergeSuperBlock" 时必传
-     */
-    public turnIntoOneTransaction(selectsElement: Element[], type: TTurnIntoOne, subType?: TTurnIntoOneSub): void
+    render(protyle: IProtyle, update?: boolean, nodeElement?: Element | false): void;
 
-    /**
-     * 多个块转换
-     * @param {Element} [nodeElement] 优先使用包含 protyle-wysiwyg--select 的块，否则使用 nodeElement 单块
-     * @param type
-     * @param {number} [subType] type 为 "Blocks2Hs" 时必传
-     */
-    public turnIntoTransaction(nodeElement: Element, type: TTurnInto, subType?: number): void
+    hide(): void;
+}
 
-    public updateTransaction(id: string, newHTML: string, html: string): void
+declare class Scroll {
+    element: HTMLElement;
+    private parentElement;
+    private inputElement;
+    lastScrollTop: number;
+    keepLazyLoad: boolean;
 
-    public updateBatchTransaction(nodeElements: Element[], cb: (e: HTMLElement) => void): void
+    constructor(protyle: IProtyle);
 
-    public getRange(element: Element): Range
+    private setIndex;
 
-    public hasClosestBlock(element: Node): false | HTMLElement
+    updateIndex(protyle: IProtyle, id: string, cb?: (index: number) => void): void;
 
-    /**
-     * @param {boolean} [toStart=true]
-     */
-    public focusBlock(element: Element, toStart?: boolean): false | Range
+    update(protyle: IProtyle): void;
+}
+
+declare class WYSIWYG {
+    lastHTMLs: {
+        [key: string]: string;
+    };
+    element: HTMLDivElement;
+    preventKeyup: boolean;
+    private shiftStartElement;
+    private preventClick;
+
+    constructor(protyle: IProtyle);
+
+    renderCustom(ial: IObject): void;
+
+    private escapeInline;
+    private setEmptyOutline;
+    private emojiToMd;
+    private bindCommonEvent;
+    private bindEvent;
+}
+
+declare class Gutter {
+    element: HTMLElement;
+    private gutterTip;
+
+    constructor(protyle: IProtyle);
+
+    private isMatchNode;
+    private turnsOneInto;
+    private turnsIntoOne;
+    private turnsInto;
+    private showMobileAppearance;
+
+    renderMultipleMenu(protyle: IProtyle, selectsElement: Element[]): Menu;
+
+    renderMenu(protyle: IProtyle, buttonElement: Element): Menu;
+
+    private genHeadingTransform;
+    private genClick;
+    private genAlign;
+    private updateNodeElements;
+    private genWidths;
+    private genHeights;
+    private genCopyTextRef;
+
+    render(protyle: IProtyle, element: Element, wysiwyg: HTMLElement, target?: Element): void;
+}
+
+declare class Title {
+    element: HTMLElement;
+    editElement: HTMLElement;
+    private timeout;
+
+    constructor(protyle: IProtyle);
+
+    private rename;
+
+    setTitle(title: string): void;
+
+    render(protyle: IProtyle, response: IWebSocketData): boolean;
+}
+
+declare class Background {
+    element: HTMLElement;
+    ial: IObject;
+    private imgElement;
+    private iconElement;
+    private actionElements;
+    private tagsElement;
+    private transparentData;
+
+    constructor(protyle: IProtyle);
+
+    private removeTag;
+
+    render(ial: IObject, rootId: string): void;
+
+    private openTag;
+    private getTags;
+    private addTags;
+}
+
+declare class Preview {
+    element: HTMLElement;
+    previewElement: HTMLElement;
+    private mdTimeoutId;
+
+    constructor(protyle: IProtyle);
+
+    render(protyle: IProtyle): void;
+
+    private link2online;
+    private copyToX;
+    private processZHBlockquote;
+    private processZHTable;
 }
 
-export class Toolbar {
+declare class Undo {
+    private hasUndo;
+    redoStack: IOperations[];
+    undoStack: IOperations[];
+
+    constructor();
+
+    undo(protyle: IProtyle): void;
+
+    redo(protyle: IProtyle): void;
+
+    private render;
+
+    replace(doOperations: IOperation[], protyle: IProtyle): void;
+
+    add(doOperations: IOperation[], undoOperations: IOperation[], protyle: IProtyle): void;
+
+    clear(): void;
+}
+
+declare class Upload {
+    element: HTMLElement;
+    isUploading: boolean;
+
+    constructor();
+}
+
+declare class Hint {
+    timeId: number;
+    element: HTMLDivElement;
+    enableSlash: boolean;
+    private enableEmoji;
+    enableExtend: boolean;
+    splitChar: string;
+    lastIndex: number;
+    private source;
+
+    constructor(protyle: IProtyle);
+
+    render(protyle: IProtyle): void;
+
+    genLoading(protyle: IProtyle): void;
+
+    bindUploadEvent(protyle: IProtyle, element: HTMLElement): void;
+
+    private getHTMLByData;
+
+    genHTML(data: IHintData[], protyle: IProtyle, hide: boolean, source: THintSource): void;
+
+    private genSearchHTML;
+    private genEmojiHTML;
+
+    fill(value: string, protyle: IProtyle, updateRange?: boolean, refIsS?: boolean): void;
+
+    select(event: KeyboardEvent, protyle: IProtyle): boolean;
+
+    private fixImageCursor;
+    private getKey;
+}
+
+export declare class Toolbar {
     public element: HTMLElement;
     public subElement: HTMLElement;
     public subElementCloseCB: () => void;
     public range: Range;
+    public toolbarHeight: number;
 
     constructor(protyle: IProtyle)
 
-    public render(protyle: IProtyle, range: Range, event?: KeyboardEvent)
-
-    public showContent(protyle: IProtyle, range: Range, nodeElement: Element)
-
-    public showWidget(protyle: IProtyle, nodeElement: HTMLElement, range: Range)
-
-    public showTpl(protyle: IProtyle, nodeElement: HTMLElement, range: Range)
-
-    public showCodeLanguage(protyle: IProtyle, languageElement: HTMLElement)
+    public render(protyle: IProtyle, range: Range, event?: KeyboardEvent): void
 
-    public showRender(protyle: IProtyle, renderElement: Element, updateElements?: Element[], oldHTML?: string)
+    public getCurrentType(range: Range): string[]
 
     public setInlineMark(protyle: IProtyle, type: string, action: "range" | "toolbar", textObj?: {
         color?: string,
         type: string
-    })
+    }): void
 
-    public getCurrentType(range: Range): string[]
+    public showRender(protyle: IProtyle, renderElement: Element, updateElements?: Element[], oldHTML?: string): void
+
+    public showCodeLanguage(protyle: IProtyle, languageElement: HTMLElement): void
+
+    public showTpl(protyle: IProtyle, nodeElement: HTMLElement, range: Range): void
 
-    public showAssets(protyle: IProtyle, position: IPosition, avCB?: (url: string) => void)
+    public showWidget(protyle: IProtyle, nodeElement: HTMLElement, range: Range): void
+
+    public showContent(protyle: IProtyle, range: Range, nodeElement: Element): void
 }
 
 export class Lute {
@@ -233,8 +452,12 @@ export class Lute {
 
     public BlockDOM2EscapeMarkerContent(text: string): string;
 
+    public SetSpin(enable: boolean): void;
+
     public SetTextMark(enable: boolean): void;
 
+    public SetHTMLTag2TextMark(enable: boolean): void;
+
     public SetHeadingID(enable: boolean): void;
 
     public SetProtyleMarkNetImg(enable: boolean): void;
@@ -259,18 +482,26 @@ export class Lute {
 
     public BlockDOM2StdMd(html: string): string;
 
-    public SetGitConflict(enable: boolean): void;
-
     public SetSuperBlock(enable: boolean): void;
 
     public SetTag(enable: boolean): void;
 
+    public SetInlineMath(enable: boolean): void;
+
+    public SetGFMStrikethrough(enable: boolean): void;
+
+    public SetGFMStrikethrough1(enable: boolean): void;
+
     public SetMark(enable: boolean): void;
 
     public SetSub(enable: boolean): void;
 
     public SetSup(enable: boolean): void;
 
+    public SetInlineAsterisk(enable: boolean): void;
+
+    public SetInlineUnderscore(enable: boolean): void;
+
     public SetBlockRef(enable: boolean): void;
 
     public SetSanitize(enable: boolean): void;
@@ -289,7 +520,7 @@ export class Lute {
 
     public SetFootnotes(enable: boolean): void;
 
-    public SetLinkRef(enalbe: boolean): void;
+    public SetLinkRef(enable: boolean): void;
 
     public SetEmojiSite(emojiSite: string): void;
 
@@ -303,9 +534,72 @@ export class Lute {
 
     public MarkdownStr(name: string, md: string): string;
 
-    public IsValidLinkDest(text: string): boolean;
+    public GetLinkDest(text: string): string;
 
     public BlockDOM2InlineBlockDOM(html: string): string;
 
     public BlockDOM2HTML(html: string): string;
+
+    public HTML2Md(html: string): string;
+
+    public HTML2BlockDOM(html: string): string;
+}
+
+export class Protyle {
+
+    public readonly version: string;
+    public protyle: IProtyle;
+
+    constructor(app: App, element: HTMLElement, options?: IProtyleOptions)
+
+    /** 聚焦到编辑器 */
+    public focus(): void
+
+    /** 上传是否还在进行中 */
+    public isUploading(): boolean
+
+    /** 清空 undo & redo 栈 */
+    public clearStack(): void
+
+    /** 销毁编辑器 */
+    public destroy(): void
+
+    public resize(): void
+
+    public reload(focus: boolean): void
+
+    /**
+     * @param {boolean} [isBlock=false]
+     * @param {boolean} [useProtyleRange=false]
+     */
+    public insert(html: string, isBlock?: boolean, useProtyleRange?: boolean): void
+
+    public 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
 }