siyuan 1.0.3 → 1.0.5

package/types/index.d.ts

@@ -1,5 +1,432 @@
+import {
+    Config, Dialog,
+    IProtyle,
+    Menu,
+    Plugin,
+    Protyle,
+    TDock,
+    TEditorMode,
+    TOperation,
+    TProtyleAction
+} from "../siyuan";
+import {Model} from "./layout/Model";
+import {Wnd} from "./layout/Wnd";
+import {Tab} from "./layout/Tab";
+import {BlockPanel} from "./block/Panel";
+import {Inbox} from "./layout/dock/Inbox";
+import {MobileOutline} from "./mobile/dock/MobileOutline";
+import {MobileFiles} from "./mobile/dock/MobileFiles";
+import {MobileBookmarks} from "./mobile/dock/MobileBookmarks";
+import {MobileTags} from "./mobile/dock/MobileTags";
+import {MobileBacklinks} from "./mobile/dock/MobileBacklinks";
+
 export * from "./config";
 export * from "./events";
 export * from "./protyle";
 export * from "./response";
 export * from "./constants";
+export * from "./layout/Wnd";
+export * from "./layout/Tab";
+export * from "./layout/Model";
+export * from "./layout/dock/Files";
+export * from "./layout/dock/Inbox";
+export * from "./block/Panel";
+export * from "./mobile/dock/MobileTags";
+export * from "./mobile/dock/MobileOutline";
+export * from "./mobile/dock/MobileBacklinks";
+export * from "./mobile/dock/MobileBookmarks";
+export * from "./mobile/dock/MobileFiles";
+export * as platformUtils from "./protyle/util/compatibility";
+
+
+type TDockPosition = "Left" | "Right" | "Bottom"
+
+export type TAVCol =
+    "text"
+    | "date"
+    | "number"
+    | "relation"
+    | "rollup"
+    | "select"
+    | "block"
+    | "mSelect"
+    | "url"
+    | "email"
+    | "phone"
+    | "mAsset"
+    | "template"
+    | "created"
+    | "updated"
+    | "checkbox"
+    | "lineNumber"
+
+interface ILayoutOptions {
+    direction?: Config.TUILayoutDirection
+    size?: string
+    resize?: Config.TUILayoutDirection
+    type?: Config.TUILayoutType
+    element?: HTMLElement
+}
+
+interface IOperationSrcs {
+    id: string,
+    content?: string,
+    isDetached: boolean
+}
+
+interface INotebook {
+    name: string
+    id: string
+    closed: boolean
+    icon: string
+    sort: number
+    dueFlashcardCount?: string;
+    newFlashcardCount?: string;
+    flashcardCount?: string;
+    sortMode: number
+}
+
+interface IEmojiItem {
+    unicode: string,
+    description: string,
+    description_zh_cn: string,
+    description_ja_jp: string,
+    keywords: string
+}
+
+interface IEmoji {
+    id: string,
+    title: string,
+    title_zh_cn: string,
+    title_ja_jp: string,
+    items: IEmojiItem[]
+}
+
+interface IBackStack {
+    id: string,
+    // 仅移动端
+    data?: {
+        startId: string,
+        endId: string
+        path: string
+        notebookId: string
+    },
+    scrollTop?: number,
+    callback?: TProtyleAction[],
+    position?: {
+        start: number,
+        end: number
+    }
+    // 仅桌面端
+    protyle?: IProtyle,
+    zoomId?: string
+}
+
+export interface IOperation {
+    action: TOperation, // move， delete 不需要传 data
+    id?: string,
+    blockID?: 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 专享
+    ignoreFillFilter?: boolean // insertAttrViewBlock 专享
+    srcIDs?: string[] // removeAttrViewBlock 专享
+    srcs?: IOperationSrcs[] // insertAttrViewBlock 专享
+    name?: string // addAttrViewCol 专享
+    type?: TAVCol // addAttrViewCol 专享
+    deckID?: string // add/removeFlashcards 专享
+    blockIDs?: string[] // add/removeFlashcards 专享
+    removeDest?: boolean // removeAttrViewCol 专享
+}
+
+export interface IPosition {
+    x: number,
+    y: number,
+    w?: number,
+    h?: number,
+    isLeft?: boolean
+}
+
+export interface ISiyuan {
+    zIndex: number
+    storage?: {
+        [key: string]: any
+    },
+    transactions?: {
+        protyle: IProtyle,
+        doOperations: IOperation[],
+        undoOperations: IOperation[]
+    }[]
+    reqIds: {
+        [key: string]: number
+    },
+    editorIsFullscreen?: boolean,
+    hideBreadcrumb?: boolean,
+    notebooks?: INotebook[],
+    emojis?: IEmoji[],
+    backStack?: IBackStack[],
+    mobile?: {
+        editor?: Protyle
+        popEditor?: Protyle
+        docks?: {
+            outline: MobileOutline | null,
+            file: MobileFiles | null,
+            bookmark: MobileBookmarks | null,
+            tag: MobileTags | null,
+            backlink: MobileBacklinks | null,
+            inbox: Inbox | null,
+        } & { [key: string]: Model | boolean };
+    },
+    user?: {
+        userId: string
+        userName: string
+        userAvatarURL: string
+        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：订阅过期
+        userToken: string
+        userTitles: {
+            name: string,
+            icon: string,
+            desc: string
+        }[]
+    },
+    dragElement?: HTMLElement,
+    layout?: {
+        layout?: Layout,
+        centerLayout?: Layout,
+        leftDock?: Dock,
+        rightDock?: Dock,
+        bottomDock?: Dock,
+    }
+    config?: Config.IConf;
+    ws: Model,
+    ctrlIsPressed?: boolean,
+    altIsPressed?: boolean,
+    shiftIsPressed?: boolean,
+    coordinates?: {
+        pageX: number,
+        pageY: number,
+        clientX: number,
+        clientY: number,
+        screenX: number,
+        screenY: number,
+    },
+    menus?: Menus
+    languages?: {
+        [key: string]: any;
+    }
+    bookmarkLabel?: string[]
+    blockPanels: BlockPanel[],
+    dialogs: Dialog[],
+    viewer?: Viewer
+}
+
+export interface IMenu {
+    checked?: boolean,
+    iconClass?: string,
+    label?: string,
+    click?: (element: HTMLElement, event: MouseEvent) => boolean | void | Promise<boolean | void>
+    type?: "separator" | "submenu" | "readonly" | "empty",
+    accelerator?: string,
+    action?: string,
+    id?: string,
+    submenu?: IMenu[]
+    disabled?: boolean
+    icon?: string
+    iconHTML?: string
+    current?: boolean
+    bind?: (element: HTMLElement) => void
+    index?: number
+    element?: HTMLElement
+    ignore?: boolean
+    waring?: boolean
+}
+
+export interface IPosition {
+    x: number,
+    y: number,
+    w?: number,
+    h?: number,
+    isLeft?: boolean
+}
+
+export interface IWebSocketData {
+    cmd: string;
+    callback?: string;
+    data: any;
+    msg: string;
+    code: number;
+    sid: string;
+}
+
+export interface IObject {
+    [key: string]: string;
+}
+
+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
+        }
+    })
+
+    public destroy(): void
+
+    public show(): void
+}
+
+export declare class Layout {
+    element: HTMLElement;
+    children?: Array<Layout | Wnd>;
+    parent?: Layout;
+    direction: Config.TUILayoutDirection;
+    type?: Config.TUILayoutType;
+    id?: string;
+    resize?: Config.TUILayoutDirection;
+    size?: string;
+
+    constructor(options?: ILayoutOptions);
+
+    addLayout(child: Layout, id?: string): void;
+
+    addWnd(child: Wnd, id?: string): void;
+}
+
+export declare class Editor extends Model {
+    element: HTMLElement;
+    editor: Protyle;
+    headElement: HTMLElement;
+
+    constructor(options: {
+        app: App;
+        tab: Tab;
+        blockId: string;
+        rootId: string;
+        mode?: TEditorMode;
+        action?: string[];
+    });
+
+    private initProtyle;
+}
+
+export declare class Dock {
+    element: HTMLElement;
+    layout: Layout;
+    private position;
+    private app;
+    resizeElement: HTMLElement;
+    pin: boolean;
+    data: {
+        [key in TDock | string]: Model | boolean;
+    };
+    private hideResizeTimeout;
+
+    constructor(options: {
+        app: App;
+        data: {
+            pin: boolean;
+            data: Config.IUILayoutDockTab[][];
+        };
+        position: TDockPosition;
+    });
+
+    togglePin(): void;
+
+    resetDockPosition(show: boolean): void;
+
+    showDock(reset?: boolean): void;
+
+    hideDock(reset?: boolean): void;
+
+    toggleModel(type: string, show?: boolean, close?: boolean, hide?: boolean, isSaveLayout?: boolean): void;
+
+    add(index: number, sourceElement: Element, previousType?: string): void;
+
+    remove(key: string): void;
+
+    setSize(): void;
+
+    private getMaxSize;
+
+    genButton(data: Config.IUILayoutDockTab[], index: number, tabIndex?: number): void;
+}
+
+export declare class Custom extends Model {
+    element: Element;
+    tab: Tab;
+    data: any;
+    type: string;
+    init: (custom: Custom) => void;
+    destroy: () => void;
+    beforeDestroy: () => void;
+    resize: () => void;
+    update: () => void;
+    editors: Protyle[];
+
+    constructor(options: {
+        app: App;
+        type: string;
+        tab: Tab;
+        data: any;
+        destroy?: () => void;
+        beforeDestroy?: () => void;
+        resize?: () => void;
+        update?: () => void;
+        init: (custom: Custom) => void;
+    });
+}
+
+export declare class subMenu {
+    menus: IMenu[];
+
+    constructor();
+
+    addSeparator(index?: number): void;
+
+    addItem(menu: IMenu): void;
+}
+
+export declare class App {
+    plugins: Plugin[];
+    appId: string
+}
+
+export declare class Menus {
+    menu: Menu;
+    constructor(app: App);
+    private getDir;
+    private unselect;
+}

package/types/layout/Model.d.ts

@@ -0,0 +1,23 @@
+import {App, IWebSocketData, Tab} from "../../siyuan";
+
+type TWS = "main" | "filetree" | "protyle"
+
+export declare class Model {
+    public ws: WebSocket;
+    public reqId: number;
+    public parent: Tab;
+    public app: App;
+
+    constructor(options: {
+        app: App,
+        id: string,
+        type?: TWS,
+        callback?: () => void,
+        msgCallback?: (data: IWebSocketData) => void
+    })
+
+    /**
+     * @param {boolean} [process=false]
+     */
+    public send(cmd: string, param: Record<string, unknown>, process: boolean): void;
+}

package/types/layout/Tab.d.ts

@@ -0,0 +1,36 @@
+import {Model} from "./Model";
+import {Wnd} from "./Wnd";
+
+interface ITab {
+    icon?: string
+    docIcon?: string
+    title?: string
+    panel?: string
+    callback?: (tab: Tab) => void
+}
+
+export declare class Tab {
+    parent: Wnd;
+    id: string;
+    headElement: HTMLElement;
+    panelElement: HTMLElement;
+    callback: (tab: Tab) => void;
+    model: Model;
+    title: string;
+    icon: string;
+    docIcon: string;
+
+    constructor(options: ITab);
+
+    updateTitle(title: string): void;
+
+    addModel(model: Model): void;
+
+    pin(): void;
+
+    setDocIcon(icon: string): void;
+
+    unpin(): void;
+
+    close(): void;
+}

package/types/layout/Wnd.d.ts

@@ -0,0 +1,34 @@
+import {Config} from "../config";
+import {App, Layout} from "../index";
+import {Tab} from "./Tab";
+
+export declare class Wnd {
+    private app;
+    id: string;
+    parent?: Layout;
+    element: HTMLElement;
+    headersElement: HTMLElement;
+    children: Tab[];
+    resize?: Config.TUILayoutDirection;
+
+    constructor(app: App, resize?: Config.TUILayoutDirection, parentType?: Config.TUILayoutType);
+
+    showHeading(): void;
+
+    switchTab(target: HTMLElement, pushBack?: boolean, update?: boolean, resize?: boolean, isSaveLayout?: boolean): void;
+
+    addTab(tab: Tab, keepCursor?: boolean, isSaveLayout?: boolean, activeTime?: string): void;
+
+    private renderTabList;
+    private removeOverCounter;
+    private destroyModel;
+    private removeTabAction;
+
+    removeTab(id: string, closeAll?: boolean, animate?: boolean, isSaveLayout?: boolean): void;
+
+    moveTab(tab: Tab, nextId?: string): void;
+
+    split(direction: Config.TUILayoutDirection): Wnd;
+
+    private remove;
+}

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

@@ -0,0 +1,56 @@
+import {App} from "../../../siyuan";
+import {Tab} from "../Tab";
+import {Model} from "../Model";
+
+interface IFile {
+    icon: string;
+    name1: string;
+    alias: string;
+    memo: string;
+    bookmark: string;
+    path: string;
+    name: string;
+    hMtime: string;
+    hCtime: string;
+    hSize: string;
+    dueFlashcardCount?: string;
+    newFlashcardCount?: string;
+    flashcardCount?: string;
+    id: string;
+    count: number;
+    subFileCount: number;
+}
+
+export declare class Files extends Model {
+    element: HTMLElement;
+    parent: Tab;
+    private actionsElement;
+    closeElement: HTMLElement;
+    constructor(options: {
+        tab: Tab;
+        app: App;
+    });
+    private genNotebook;
+    init(init?: boolean): void;
+    private onRemove;
+    private onMount;
+    onRename(data: {
+        path: string;
+        title: string;
+        box: string;
+    }): void;
+    private onMove;
+    private onLsHTML;
+    private onLsSelect;
+    private setCurrent;
+    getLeaf(liElement: Element, notebookId: string): void;
+    selectItem(notebookId: string, filePath: string, data?: {
+        files: IFile[];
+        box: string;
+        path: string;
+    }, setStorage?: boolean): void;
+    private getOpenPaths;
+    private genDocAriaLabel;
+    private genFileHTML;
+    private initMoreMenu;
+}

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

@@ -0,0 +1,18 @@
+import { Tab } from "../Tab";
+import { Model } from "../Model";
+import { App } from "../../index";
+export declare class Inbox extends Model {
+    private element;
+    private selectIds;
+    private currentPage;
+    private pageCount;
+    private data;
+    constructor(app: App, tab: Tab | Element);
+    private back;
+    private genDetail;
+    private genItemHTML;
+    private more;
+    private remove;
+    private move;
+    private update;
+}

package/types/mobile/dock/MobileBacklinks.d.ts

@@ -0,0 +1,10 @@
+import { App } from "../../index";
+export declare class MobileBacklinks {
+    element: HTMLElement;
+    private tree;
+    private notebookId;
+    private mTree;
+    beforeLen: number;
+    constructor(app: App);
+    update(): void;
+}

package/types/mobile/dock/MobileBookmarks.d.ts

@@ -0,0 +1,8 @@
+import { App } from "../../index";
+export declare class MobileBookmarks {
+    element: HTMLElement;
+    private tree;
+    private openNodes;
+    constructor(app: App);
+    update(): void;
+}

package/types/mobile/dock/MobileFiles.d.ts

@@ -0,0 +1,31 @@
+import { Model } from "../../layout/Model";
+import {App, IFile} from "../../index";
+export declare class MobileFiles extends Model {
+    element: HTMLElement;
+    private actionsElement;
+    private closeElement;
+    constructor(app: App);
+    private genSort;
+    private genNotebook;
+    init(init?: boolean): void;
+    private onMove;
+    private onMkdir;
+    private onRemove;
+    onRename(data: {
+        path: string;
+        title: string;
+        box: string;
+    }): void;
+    private onMount;
+    private onLsHTML;
+    private onLsSelect;
+    private setCurrent;
+    getLeaf(liElement: Element, notebookId: string): void;
+    selectItem(notebookId: string, filePath: string, data?: {
+        files: IFile[];
+        box: string;
+        path: string;
+    }, setStorage?: boolean): void;
+    private getOpenPaths;
+    private genFileHTML;
+}

package/types/mobile/dock/MobileOutline.d.ts

@@ -0,0 +1,12 @@
+import { App } from "../../index";
+import { Model } from "../../layout/Model";
+export declare class MobileOutline extends Model {
+    private tree;
+    private openNodes;
+    private element;
+    constructor(app: App);
+    update(): void;
+    private setCurrentByPreview;
+    private setCurrentById;
+    private setCurrent;
+}

package/types/mobile/dock/MobileTags.d.ts

@@ -0,0 +1,8 @@
+import { App } from "../../index";
+export declare class MobileTags {
+    element: HTMLElement;
+    private tree;
+    private openNodes;
+    constructor(app: App);
+    update(): void;
+}

package/types/protyle/util/compatibility.d.ts

@@ -0,0 +1,16 @@
+export declare const openByMobile: (uri: string) => void;
+export declare const readText: () => string | Promise<string>;
+export declare const writeText: (text: string) => void;
+export declare const copyPlainText: (text: string) => Promise<void>;
+export declare const getEventName: () => "click" | "touchstart";
+export declare const isOnlyMeta: (event: KeyboardEvent | MouseEvent) => boolean;
+export declare const isNotCtrl: (event: KeyboardEvent | MouseEvent) => boolean;
+export declare const isHuawei: () => boolean;
+export declare const isIPhone: () => boolean;
+export declare const isIPad: () => boolean;
+export declare const isMac: () => boolean;
+export declare const isInAndroid: () => boolean;
+export declare const isInIOS: () => any;
+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;