type TLayout = "normal" | "bottom" | "left" | "right" | "center" type TSearchFilter = "mathBlock" | "table" | "blockquote" | "superBlock" | "paragraph" | "document" | "heading" | "list" | "listItem" | "codeBlock" | "htmlBlock" type TDirection = "lr" | "tb" type TDockType = "file" | "outline" | "bookmark" | "tag" | "graph" | "globalGraph" | "backlink" | "backlinkOld" | "inbox" type TDockPosition = "Left" | "Right" | "Bottom" type TWS = "main" | "filetree" | "protyle" type TEditorMode = "preview" | "wysiwyg" type TOperation = "insert" | "update" | "delete" | "move" | "foldHeading" | "unfoldHeading" | "setAttrs" | "updateAttrs" | "append" | "insertAttrViewBlock" | "removeAttrViewBlock" type TBazaarType = "templates" | "icons" | "widgets" | "themes" declare module "blueimp-md5" interface Window { __localStorage__removeItem: (key: string) => void __localStorage__setItem: (key: string, value: string) => void dataLayer: any[] siyuan: ISiyuan webkit: any html2canvas: (element: Element) => Promise; JSAndroid: { returnDesktop(): void openExternal(url: string): void changeStatusBarColor(color: string, mode: number): void writeClipboard(text: string): void writeImageClipboard(uri: string): void readClipboard(): string getBlockURL(): string } goBack(): void showKeyboardToolbar(height: number): void hideKeyboardToolbar(): void openFileByURL(URL: string): boolean } interface ISaveLayout { name: string, layout: IObject } interface IWorkspace { path: string closed: boolean } interface ICardPackage { id: string updated: string name: string size: number } interface ICard { deckID: string cardID: string blockID: string nextDues: IObject } interface ISearchOption { 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 } } interface ITextOption { color?: string, type: string } interface ISnippet { id?: string name: string type: string enabled: boolean content: string } interface IInbox { oId: string shorthandContent: string shorthandDesc: string shorthandFrom: number shorthandTitle: string shorthandURL: string hCreated: string } interface IPdfAnno { pages?: { index: number positions: number [] }[] index?: number, color: string, type: string, // border, text content: string, // rect, text mode: string, id?: string, coords?: number[] } interface IBackStack { id: string, endId?: string, scrollTop?: number, callback?: string[], position?: { start: number, end: number } protyle?: IProtyle, isZoom?: boolean } interface IEmoji { id: string, title: string, title_zh_cn: string, items: { unicode: string, description: string, description_zh_cn: string, keywords: string }[] } interface INotebook { name: string id: string closed: boolean icon: string sort: number sortMode: number } interface ISiyuan { storage?: { [key: string]: any }, printWin?: import("electron").BrowserWindow transactionsTimeout?: number, transactions?: { protyle: IProtyle, doOperations: IOperation[], undoOperations: IOperation[] }[] reqIds: { [key: string]: number }, editorIsFullscreen?: boolean, hideBreadcrumb?: boolean, notebooks?: INotebook[], emojis?: IEmoji[], backStack?: IBackStack[], mobile?: { editor?: import("../protyle").Protyle files?: import("../mobile/util/MobileFiles").MobileFiles }, user?: { userId: string userName: string userAvatarURL: string userHomeBImgURL: string userIntro: string userNickname: string userPaymentSum: string 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?: import("../layout").Layout, centerLayout?: import("../layout").Layout, leftDock?: import("../layout/dock").Dock, rightDock?: import("../layout/dock").Dock, bottomDock?: import("../layout/dock").Dock, } config?: IConfig; ws: import("../layout/Model").Model, ctrlIsPressed?: boolean, altIsPressed?: boolean, shiftIsPressed?: boolean, menus?: import("../menus").Menus languages?: { [key: string]: any; } bookmarkLabel?: string[] blockPanels: import("../block/Panel").BlockPanel[], dialogs: import("../dialog").Dialog[], } interface IScrollAttr { startId: string, endId: string scrollTop: number, focusId?: string, focusStart?: number focusEnd?: number zoomInId?: string } interface IOperation { action: TOperation, // move， delete 不需要传 data id: string, data?: string, // updateAttr 时为 { old: IObject, new: IObject } parentID?: string // 为 insertAttrViewBlock 传 avid previousID?: string retData?: any nextID?: string // insert 专享 srcIDs?: string[] // insertAttrViewBlock 专享 } interface IObject { [key: string]: string; } declare interface IDockTab { type: TDockType; size: { width: number, height: number } show: boolean icon: string hotkeyLangId: string } declare interface IOpenFileOptions { assetPath?: string, // asset 必填 fileName?: string, // file 必填 rootIcon?: string, // 文档图标 id?: string, // file 必填 rootID?: string, // file 必填 position?: string, // file 或者 asset，打开位置 page?: number | string, // asset mode?: TEditorMode // file action?: string[] keepCursor?: boolean // file，是否跳转到新 tab 上 zoomIn?: boolean // 是否缩放 removeCurrentTab?: boolean // 在当前页签打开时需移除原有页签 } declare interface ILayoutOptions { direction?: TDirection; size?: string resize?: TDirection type?: TLayout element?: HTMLElement } declare interface ITab { icon?: string docIcon?: string title?: string panel?: string callback?: (tab: import("../layout/Tab").Tab) => void } declare interface IExport { fileAnnotationRefMode: number blockRefMode: number blockEmbedMode: number blockRefTextLeft: string blockRefTextRight: string tagOpenMarker: string tagCloseMarker: string pandocBin: string paragraphBeginningSpace: boolean; addTitle: boolean; addFooter: boolean; markdownYFM: boolean; } declare interface IEditor { justify: boolean; rtl: boolean; readOnly: boolean; listLogicalOutdent: boolean; spellcheck: boolean; katexMacros: string; fullWidth: boolean; floatWindowMode: number; dynamicLoadBlocks: number; fontSize: number; generateHistoryInterval: number; historyRetentionDays: number; codeLineWrap: boolean; displayBookmarkIcon: boolean; displayNetImgMark: boolean; codeSyntaxHighlightLineNum: boolean; embedBlockBreadcrumb: boolean; plantUMLServePath: string; codeLigatures: boolean; codeTabSpaces: number; fontFamily: string; virtualBlockRef: string; virtualBlockRefExclude: string; virtualBlockRefInclude: string; blockRefDynamicAnchorTextMaxLen: number; backlinkExpandCount: number; emoji: string[]; } declare interface IWebSocketData { cmd: string callback?: string data: any msg: string code: number sid: string } declare interface IAppearance { modeOS: boolean, hideStatusBar: boolean, nativeEmoji: boolean, customCSS: boolean, themeJS: boolean, mode: number, // 1 暗黑；0 明亮 icon: string, closeButtonBehavior: number // 0：退出，1：最小化到托盘 codeBlockThemeDark: string codeBlockThemeLight: string themeDark: string themeLight: string icons: string[] lang: string iconVer: string themeVer: string lightThemes: string[] darkThemes: string[] } declare interface IFileTree { closeTabsOnStart: boolean alwaysSelectOpenedFile: boolean openFilesUseCurrentTab: boolean removeDocWithoutConfirm: boolean allowCreateDeeper: boolean refCreateSavePath: string docCreateSavePath: string sort: number maxOpenTabCount: number maxListCount: number } declare interface IAccount { displayTitle: boolean displayVIP: boolean } declare interface IConfig { repo: { key: string }, sync: { generateConflictDoc: boolean enabled: boolean mode: number synced: number stat: string interval: number cloudName: string provider: number // 0 官方同步， 2 S3， 3 WebDAV s3: { endpoint: string pathStyle: boolean accessKey: string secretKey: string bucket: string region: string skipTlsVerify: boolean timeout: number } webdav: { endpoint: string username: string password: string skipTlsVerify: boolean timeout: number } }, lang: string api: { token: string } openHelp: boolean system: { networkProxy: { host: string port: string scheme: string } kernelVersion: string isInsider: boolean appDir: string workspaceDir: string confDir: string dataDir: string container: "std" | "android" | "docker" | "ios" isMicrosoftStore: boolean os: "windows" | "linux" | "darwin" osPlatform: string homeDir: string xanadu: boolean udanax: boolean uploadErrLog: boolean disableGoogleAnalytics: boolean downloadInstallPkg: boolean networkServe: boolean fixedPort: boolean autoLaunch: boolean } localIPs: string[] readonly: boolean // 全局只读 uiLayout: Record langs: { label: string, name: string }[] appearance: IAppearance editor: IEditor, fileTree: IFileTree graph: IGraph keymap: IKeymap export: IExport accessAuthCode: string account: IAccount tag: { sort: number } search: { embedBlock: boolean htmlBlock: boolean document: boolean heading: boolean list: boolean listItem: boolean codeBlock: boolean mathBlock: boolean table: boolean blockquote: boolean superBlock: boolean paragraph: boolean name: boolean alias: boolean memo: boolean ial: boolean limit: number caseSensitive: boolean backlinkMentionName: boolean backlinkMentionAlias: boolean backlinkMentionAnchor: boolean backlinkMentionDoc: boolean backlinkMentionKeywordsLimit: boolean virtualRefName: boolean virtualRefAlias: boolean virtualRefAnchor: boolean virtualRefDoc: boolean }, stat: { treeCount: number cTreeCount: number blockCount: number cBlockCount: number dataSize: number cDataSize: number assetsSize: number cAssetsSize: number } } declare interface IGraphCommon { d3: { centerStrength: number collideRadius: number collideStrength: number lineOpacity: number linkDistance: number linkWidth: number nodeSize: number arrow: boolean } type: { blockquote: boolean code: boolean heading: boolean list: boolean listItem: boolean math: boolean paragraph: boolean super: boolean table: boolean tag: boolean } } declare interface IGraph { global: { minRefs: number dailyNote: boolean } & IGraphCommon local: { dailyNote: boolean } & IGraphCommon } declare interface IKeymap { 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 } } } declare interface IKeymapItem { default: string, custom: string } declare interface IFile { icon: string; name1: string; alias: string; memo: string; bookmark: string; path: string; name: string; hMtime: string; hCtime: string; hSize: string; id: string; count: number; subFileCount: number; } declare interface IBlockTree { box: string, nodeType: string, hPath: string, subType: string, name: string, type: string, depth: number, url?: string, label?: string, id?: string, blocks?: IBlock[], count: number, children?: IBlockTree[] } declare interface IBlock { depth?: number, box?: string; path?: string; hPath?: string; id?: string; rootID?: string; type?: string; content?: string; def?: IBlock; defID?: string defPath?: string refText?: string; name?: string; memo?: string; alias?: string; refs?: IBlock[]; children?: IBlock[] length?: number ial: IObject } declare class Layout{ public element: HTMLElement; public children?: Array; public parent?: Layout; public direction: TDirection; public type?: TLayout; public id?: string; public resize?: TDirection; public size?: string; constructor(options?: ILayoutOptions) addLayout(child: Layout, id?: string) addWnd(child: Wnd, id?: string) } declare class Wnd{ public id: string; public parent?: Layout; public element: HTMLElement; public headersElement: HTMLElement; public children: Tab[] ; public resize?: TDirection; constructor(resize?: TDirection, parentType?: TLayout) public showHeading() public switchTab(target: HTMLElement, pushBack : boolean, update : boolean) public addTab(tab: Tab, keepCursor : boolean) private renderTabList(event: MouseEvent) private removeOverCounter(oldFocusIndex?: number) private destroyModel(model: Model) private removeTabAction (id: string, closeAll: boolean, hasSaveScroll : boolean, animate : boolean) public moveTab(tab: Tab, nextId?: string) public split(direction: TDirection) private remove() } declare class Tab{ public parent: Wnd; public id: string; public headElement: HTMLElement; public panelElement: HTMLElement; public callback: (tab: Tab) => void; public model: Model; public title: string; public icon: string; public docIcon: string; constructor(options: ITab) public updateTitle(title: string) public addModel(model: Model) public pin() public setDocIcon(icon: string) public unpin() } declare class Protyle { public readonly version: string; public protyle: IProtyle; /** * @param id 要挂载 Protyle 的元素或者元素 ID。 * @param options Protyle 参数 */ constructor(id: HTMLElement, options?: IOptions) private init() /** 聚焦到编辑器 */ public focus() public isUploading() :boolean /** 清空 undo & redo 栈 */ public clearStack() /** 销毁编辑器 */ public destroy() } declare class Model{ public ws: WebSocket; public reqId: number; /// #if !MOBILE public parent: Tab; /// #else // @ts-ignore public parent: any; private connect(options: { id: string, type?: TWS, callback?: () => void, msgCallback?: (data: IWebSocketData) => void }) public send(cmd: string, param: Record, process :boolean):void } declare class Editor extends Model { public element: HTMLElement; public editor: Protyle; public headElement: HTMLElement; constructor(options: { tab: Tab, blockId: string, mode?: TEditorMode, action?: string[], scrollAttr?: IScrollAttr }) private initProtyle(options: { blockId: string, action?: string[] mode?: TEditorMode, scrollAttr?: IScrollAttr }) } declare interface IModels { editor: import("../editor").Editor [], graph: import("../layout/dock/Graph").Graph[], outline: import("../layout/dock/Outline").Outline[] backlink: import("../layout/dock/Backlink").Backlink[] asset: import("../asset").Asset[] search: import("../search").Search[] } declare interface IMenu { label?: string, click?: (element: HTMLElement) => void, type?: "separator" | "submenu" | "readonly", accelerator?: string, action?: string, id?: string, submenu?: IMenu[] disabled?: boolean icon?: string iconHTML?: string current?: boolean bind?: (element: HTMLElement) => void } declare interface IBazaarItem { readme: string stars: string author: string updated: string downloads: string current: false installed: false outdated: false name: string previewURL: string previewURLThumb: string repoHash: string repoURL: string url: string openIssues: number version: string modes: string[] hSize: string hInstallSize: string hInstallDate: string hUpdated: string }