init

src/siyuan.d.ts

@@ -0,0 +1,206 @@
+/*
+ * Copyright (c) 2023, Terwer . All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Terwer designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Terwer in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Terwer, Shenzhen, Guangdong, China, youweics@163.com
+ * or visit www.terwer.space if you need additional information or have any
+ * questions.
+ */
+
+declare module "siyuan" {
+    type TEventBus = "ws-main"
+
+    interface IObject {
+        [key: string]: string;
+    }
+
+    interface IWebSocketData {
+        cmd: string
+        callback?: string
+        data: any
+        msg: string
+        code: number
+        sid: string
+    }
+
+    declare interface IPluginDockTab {
+        position: "LeftTop" | "LeftBottom" | "RightTop" | "RightBottom" | "BottomLeft" | "BottomRight",
+        size: { width: number, height: number },
+        icon: string,
+        hotkey?: string,
+        title: string,
+    }
+
+    interface IMenuItemOption {
+        label?: string,
+        click?: (element: HTMLElement) => 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
+    }
+
+    export function fetchPost(url: string, data?: any, cb?: (response: IWebSocketData) => void, headers?: IObject): void;
+
+    export function fetchSyncPost(url: string, data?: any): Promise<IWebSocketData>;
+
+    export function fetchGet(url: string, cb: (response: IWebSocketData) => void): void;
+
+    export function openTab(options: {
+        custom?: {
+            title: string,
+            icon: string,
+            data?: any
+            fn?: () => any,
+        }   // card 和自定义页签 必填
+        position?: "right" | "bottom",
+        keepCursor?: boolean // 是否跳转到新 tab 上
+        removeCurrentTab?: boolean // 在当前页签打开时需移除原有页签
+        afterOpen?: () => void // 打开后回调
+    }): void
+
+    export function isMobile(): boolean;
+
+    export function adaptHotkey(hotkey: string): string;
+
+    export function confirm(title: string, text: string, confirmCB?: () => void, cancelCB?: () => void): void;
+
+    /**
+     * @param timeout - ms. 0: manual close；-1: always show; 6000: default
+     * @param {string} [type=info]
+     */
+    export function showMessage(text: string, timeout?: number, type?: "info" | "error", id?: string): void;
+
+    export class App {
+        plugins: Plugin[];
+    }
+
+    export abstract class Plugin {
+        eventBus: EventBus;
+        i18n: IObject;
+        data: any;
+        name: string;
+
+        constructor(options: {
+            app: App,
+            id: string,
+            name: string,
+            i18n: IObject
+        })
+
+        onload(): void;
+
+        onunload(): void;
+
+        /*
+         * @param {string} [options.position=right]
+         */
+        addTopBar(options: {
+            icon: string,
+            title: string,
+            callback: (evt: MouseEvent) => void
+            position?: "right" | "left"
+        }): HTMLDivElement;
+
+        openSetting(): void
+
+        // registerCommand(command: IPluginCommand): void;
+
+        // registerSettingRender(settingRender: SettingRender): void;
+
+        loadData(storageName: string): Promise<any>;
+
+        saveData(storageName: string, content: any): Promise<void>;
+
+        removeData(storageName: string): Promise<any>;
+
+        addTab(options: {
+            type: string,
+            destroy?: () => void,
+            resize?: () => void,
+            update?: () => void,
+            init: () => void
+        }): () => any
+
+        addDock(options: {
+            config: IPluginDockTab,
+            data: any,
+            type: string,
+            destroy?: () => void,
+            resize?: () => void,
+            update?: () => void,
+            init: () => void
+        }): any
+    }
+
+    export class EventBus {
+        on(type: TEventBus, listener: (event: CustomEvent<any>) => void): void;
+
+        once(type: TEventBus, listener: (event: CustomEvent<any>) => void): void;
+
+        off(type: TEventBus, listener: (event: CustomEvent<any>) => void): void;
+
+        emit(type: TEventBus, detail?: any): boolean;
+    }
+
+    export class Dialog {
+
+        element: HTMLElement;
+
+        constructor(options: {
+            title?: string,
+            transparent?: boolean,
+            content: string,
+            width?: string
+            height?: string,
+            destroyCallback?: (options?: IObject) => void
+            disableClose?: boolean
+            disableAnimation?: boolean
+        });
+
+        destroy(options?: IObject): void;
+
+        bindInput(inputElement: HTMLInputElement | HTMLTextAreaElement, enterEvent?: () => void): void;
+    }
+
+    export class Menu {
+        constructor(id?: string, closeCB?: () => void);
+
+        showSubMenu(subMenuElement: HTMLElement): void;
+
+        addItem(options: IMenuItemOption): HTMLElement;
+
+        addSeparator(): void;
+
+        open(options: { x: number, y: number, h?: number, w?: number, isLeft?: boolean }): void;
+
+        /*
+         * @param {string} [position=all]
+         */
+        fullscreen(position?: "bottom" | "all"): void;
+
+        close(): void;
+    }
+}