An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作
TypeScript agentic-aiai-agentknowledge-baselocal-firstmarkdownmcpmindmapnote-takingself-hostedsiyuanworkspace
import {confirmDialog} from "../dialog/confirmDialog";
import {Plugin} from "./index";
import {hideMessage, showMessage} from "../dialog/message";
import {Dialog} from "../dialog";
import {openInputDialog} from "../dialog/inputDialog";
import {fetchGet, fetchPost, fetchSyncPost} from "../util/fetch";
import {getBackend, getFrontend} from "../util/functions";
/// #if !MOBILE
import {openFile, openFileById} from "../editor/util";
import {openNewWindow, openNewWindowById} from "../window/openNewWindow";
import {Tab} from "../layout/Tab";
/// #endif
import {saveExportFile, updateHotkeyTip} from "../protyle/util/compatibility";
import * as platformUtils from "./platformUtils";
import type {App} from "../index";
import {Constants} from "../constants";
import {Setting} from "./Setting";
import {Menu} from "./Menu";
import {Protyle} from "../protyle";
import {openMobileFileById} from "../mobile/editor";
import {exitSiYuan, lockScreen} from "../dialog/processSystem";
import {Model} from "../layout/Model";
/// #if !MOBILE
import {getActiveTab, getDockByType} from "../layout/tabUtil";
import {getAllModels, getAllTabs} from "../layout/getAll";
import {exportLayout} from "../layout/util";
/// #endif
import {getAllEditor} from "../layout/getAll";
import {openPluginSetting} from "../config";
import {openAttr, openFileAttr} from "../menus/commonMenuItem";
import {globalCommand} from "../boot/globalEvent/command/global";
import {saveMobileLayout} from "../mobile/util/saveLayout";
import {hasClosestByClassName} from "../protyle/util/hasClosest";
import type {MobileFiles} from "../mobile/dock/MobileFiles";
import type {Files} from "../layout/dock/Files";
import {ProtyleMethod} from "./ProtyleMethod";
import {openEmojiPanel} from "../emoji";
import {openAssetPicker} from "../asset/picker";
import {adjustEditorFontSize, setEditorFontSize} from "../util/editorFontSize";
import {insertEditorContent, IInsertContentOptions} from "./insertContent";
/// #if !MOBILE
import {isDockPanelVisible, toggleDockPanel} from "../layout/dock/panel";
/// #endif
let openTab: (options: any) => any;
let openWindow: (options: any) => void;
/// #if MOBILE
openTab = () => {
// TODO: Mobile
};
openWindow = () => {
// TODO: Mobile
};
/// #else
openWindow = (options: {
position?: IPosition,
height?: number,
width?: number,
tab?: Tab,
alwaysOnTop?: boolean,
doc?: {
id: string, // 块 id
},
}) => {
if (options.doc && options.doc.id) {
openNewWindowById(options.doc.id, {
alwaysOnTop: options.alwaysOnTop,
position: options.position,
width: options.width,
height: options.height
});
return;
}
if (options.tab) {
openNewWindow(options.tab, {
alwaysOnTop: options.alwaysOnTop,
position: options.position,
width: options.width,
height: options.height
});
return;
}
};
openTab = (options: {
app: App,
doc?: {
id: string, // 块 id
action?: TProtyleAction [] // cb-get-all:获取所有内容;cb-get-focus:打开后光标定位在 id 所在的块;cb-get-hl: 打开后 id 块高亮
zoomIn?: boolean // 是否缩放
mode?: TEditorMode // 文档打开模式,默认 "wysiwyg"
},
pdf?: {
path: string,
page?: number, // pdf 页码
id?: string, // File Annotation id
},
asset?: {
path: string,
},
search?: Config.IUILayoutTabSearchConfig
card?: {
type: TCardType,
id?: string, // cardType 为 all 时不传,否则传文档或笔记本 id
title?: string // cardType 为 all 时不传,否则传文档或笔记本名称
},
custom?: {
title: string,
icon: string,
data?: any
id: string
}
position?: "right" | "bottom",
keepCursor?: boolean // 是否跳转到新 tab 上
removeCurrentTab?: boolean // 在当前页签打开时需移除原有页签
afterOpen?: (model?: Model) => void // 打开后回调
}) => {
if (options.doc) {
if (options.doc.zoomIn) {
if (options.doc.action && !options.doc.action.includes(Constants.CB_GET_ALL)) {
options.doc.action.push(Constants.CB_GET_ALL);
} else {
options.doc.action = [Constants.CB_GET_ALL];
}
}
if (!options.doc.action) {
options.doc.action = [];
}
return openFileById({
app: options.app,
keepCursor: options.keepCursor,
removeCurrentTab: options.removeCurrentTab,
position: options.position,
afterOpen: options.afterOpen,
id: options.doc.id,
action: options.doc.action,
zoomIn: options.doc.zoomIn,
scrollPosition: "start",
mode: options.doc.mode,
});
}
if (options.asset) {
return openFile({
app: options.app,
keepCursor: options.keepCursor,
removeCurrentTab: options.removeCurrentTab,
position: options.position,
afterOpen: options.afterOpen,
assetPath: options.asset.path,
});
}
if (options.pdf) {
return openFile({
app: options.app,
keepCursor: options.keepCursor,
removeCurrentTab: options.removeCurrentTab,
position: options.position,
afterOpen: options.afterOpen,
assetPath: options.pdf.path,
page: options.pdf.id || options.pdf.page,
});
}
if (options.search) {
if (!options.search.idPath) {
options.search.idPath = [];
}
if (!options.search.hPath) {
options.search.hPath = "";
}
return openFile({
app: options.app,
keepCursor: options.keepCursor,
removeCurrentTab: options.removeCurrentTab,
position: options.position,
afterOpen: options.afterOpen,
searchData: options.search,
});
}
if (options.card) {
return openFile({
app: options.app,
keepCursor: options.keepCursor,
removeCurrentTab: options.removeCurrentTab,
position: options.position,
afterOpen: options.afterOpen,
custom: {
icon: "iconRiffCard",
title: window.siyuan.languages.spaceRepetition,
data: {
cardType: options.card.type,
id: options.card.id || "",
title: options.card.title,
},
id: "siyuan-card"
},
});
}
if (options.custom) {
return openFile(options);
}
};
/// #endif
const getModelByDockType = (type: TDock | string) => {
/// #if MOBILE
return window.siyuan.mobile.docks[type];
/// #else
return getDockByType(type).data[type];
/// #endif
};
const openAttributePanel = (options: {
data?: Record<string, string> // 块属性值
nodeElement?: HTMLElement, // 块元素
focusName: "bookmark" | "name" | "alias" | "memo" | "av" | "custom", // av 为数据库页签,custom 为自定义页签,其余为内置输入框
protyle?: IProtyle, // 有数据库时需要传入 protyle
}) => {
if (options.data) {
openFileAttr(options.data, options.focusName, options.protyle);
} else {
openAttr(options.nodeElement, options.focusName, options.protyle);
}
};
const saveLayout = (cb: () => void) => {
/// #if MOBILE
void saveMobileLayout().then((saved) => {
if (saved) {
cb?.();
} else {
showMessage(window.siyuan.languages.mobileLayoutSaveError, 6000, "error");
}
});
/// #else
exportLayout({cb, errorExit: false});
/// #endif
};
const getActiveEditor = (wndActive = true) => {
let editor;
/// #if !MOBILE
const range = getSelection().rangeCount > 0 ? getSelection().getRangeAt(0) : null;
const allEditor = getAllEditor();
if (range) {
editor = allEditor.find(item => {
if (!item.protyle.element.classList.contains("fn__none") &&
item.protyle.element.contains(range.startContainer)) {
return true;
}
});
}
if (!editor) {
editor = allEditor.find(item => {
if (!item.protyle.element.classList.contains("fn__none") &&
hasClosestByClassName(item.protyle.element, "layout__wnd--active", true)) {
return true;
}
});
}
if (!editor && !wndActive) {
let activeTime = 0;
allEditor.forEach(item => {
let headerElement = item.protyle.model?.parent.headElement;
if (!headerElement && item.protyle.element.getBoundingClientRect().height > 0) {
const tabBodyElement = item.protyle.element.closest(".fn__flex-1[data-id]");
if (tabBodyElement) {
headerElement = document.querySelector(`.layout-tab-bar .item[data-id="${tabBodyElement.getAttribute("data-id")}"]`);
}
}
if (headerElement) {
if (headerElement.classList.contains("item--focus") && parseInt(headerElement.dataset.activetime) > activeTime) {
activeTime = parseInt(headerElement.dataset.activetime);
editor = item;
}
} else if (item.protyle.element.getBoundingClientRect().height > 0) {
editor = item;
}
});
}
/// #else
editor = window.siyuan.mobile.popEditor || window.siyuan.mobile.editor;
if (editor?.protyle.element.classList.contains("fn__none")) {
return undefined;
}
/// #endif
return editor;
};
const insertContent = (options: IInsertContentOptions) => {
if (options?.editor) {
return insertEditorContent(options, []);
}
let editors: Protyle[];
/// #if MOBILE
editors = [window.siyuan.mobile.popEditor, window.siyuan.mobile.editor].filter(Boolean);
/// #else
editors = getAllModels().editor.map(model => model.editor);
/// #endif
return insertEditorContent(options, editors);
};
export const expandDocTree = async (options: {
id: string,
isSetCurrent?: boolean
}) => {
let isNotebook = false;
window.siyuan.notebooks.find(item => {
if (options.id === item.id) {
isNotebook = true;
return true;
}
});
let liElement: HTMLElement;
let notebookId = options.id;
const file = getModelByDockType("file") as MobileFiles | Files;
if (typeof options.isSetCurrent === "undefined") {
options.isSetCurrent = true;
}
if (isNotebook) {
liElement = file.element.querySelector(`.b3-list[data-url="${options.id}"]`)?.firstElementChild as HTMLElement;
} else {
const response = await fetchSyncPost("/api/block/getBlockInfo", {id: options.id});
if (response.code !== 0 || response.data.publishAccessRequired) {
return;
}
notebookId = response.data.box;
liElement = await file.selectItem(response.data.box, response.data.path, undefined, undefined, options.isSetCurrent);
}
if (!liElement) {
return;
}
if (options.isSetCurrent || typeof options.isSetCurrent === "undefined") {
file.setCurrent(liElement);
}
const toggleElement = liElement.querySelector(".b3-list-item__arrow");
if (toggleElement.classList.contains("b3-list-item__arrow--open")) {
return;
}
file.getLeaf(liElement, notebookId);
};
const openEmoji = (options: {
position: IPosition,
selectedCB?: (emoji: string) => void,
dynamicIconURL?: string
hideDynamicIcon?: boolean
hideCustomIcon?: boolean
targetID?: string
}) => {
let dynamicImgElement: HTMLImageElement;
if (options.dynamicIconURL) {
dynamicImgElement = document.createElement("img");
dynamicImgElement.src = options.dynamicIconURL;
}
openEmojiPanel("", "av", options.position, options.selectedCB, dynamicImgElement, {
dynamic: options.hideDynamicIcon,
custom: options.hideCustomIcon,
targetID: options.targetID,
});
};
const toggleLeftDock = (visible?: boolean) => {
/// #if MOBILE
return false;
/// #else
return toggleDockPanel("Left", visible);
/// #endif
};
const toggleRightDock = (visible?: boolean) => {
/// #if MOBILE
return false;
/// #else
return toggleDockPanel("Right", visible);
/// #endif
};
const toggleBottomDock = (visible?: boolean) => {
/// #if MOBILE
return false;
/// #else
return toggleDockPanel("Bottom", visible);
/// #endif
};
const isLeftDockVisible = () => {
/// #if MOBILE
return false;
/// #else
return isDockPanelVisible("Left");
/// #endif
};
const isRightDockVisible = () => {
/// #if MOBILE
return false;
/// #else
return isDockPanelVisible("Right");
/// #endif
};
const isBottomDockVisible = () => {
/// #if MOBILE
return false;
/// #else
return isDockPanelVisible("Bottom");
/// #endif
};
const createAPI = () => ({
adaptHotkey: updateHotkeyTip,
confirm: confirmDialog,
Constants,
showMessage,
hideMessage,
adjustEditorFontSize,
setEditorFontSize,
fetchPost,
fetchSyncPost,
fetchGet,
getFrontend,
getBackend,
getModelByDockType,
openTab,
openWindow,
openMobileFileById,
lockScreen,
exitSiYuan,
Protyle,
ProtyleMethod,
Plugin,
Dialog,
openInputDialog,
Menu,
Setting,
getAllEditor,
saveExportFile,
/// #if !MOBILE
getActiveTab,
getAllModels,
getAllTabs,
/// #endif
getActiveEditor,
insertContent,
platformUtils,
openSetting: openPluginSetting,
openAttributePanel,
saveLayout,
globalCommand,
expandDocTree,
openEmoji,
openAssetPicker,
toggleLeftDock,
toggleRightDock,
toggleBottomDock,
isLeftDockVisible,
isRightDockVisible,
isBottomDockVisible,
});
let api: ReturnType<typeof createAPI>;
export const getAPI = () => {
// 在插件首次请求接口时初始化,避免循环依赖读取尚未初始化的模块成员。
if (!api) {
api = createAPI();
}
return api;
};