obsidian-typings 2.3.2 → 2.3.4

package/dist/types.d.ts

@@ -2483,7 +2483,7 @@ export interface PropertyWidget<T> {
  * @todo Documentation incomplete
  */
 /** @public */
-export type PropertyWidgetType = "aliases" | "checkbox" | "date" | "datetime" | "multitext" | "number" | "tags" | "text" | (string & any);
+export type PropertyWidgetType = "aliases" | "checkbox" | "date" | "datetime" | "multitext" | "number" | "tags" | "text" | string;
 /** @public */
 export interface MetadataTypeManagerPropertiesRecord extends Record<string, PropertyInfo> {
 }
@@ -2491,7 +2491,12 @@ export interface MetadataTypeManagerPropertiesRecord extends Record<string, Prop
 export interface MetadataTypeManagerRegisteredTypeWidgetsRecord extends Record<PropertyWidgetType, PropertyWidget<unknown>> {
 }
 /** @public */
-export interface MetadataTypeManagerTypesRecord extends Record<string, PropertyWidgetType> {
+export interface PropertyWidgetEntry {
+	name: string;
+	type: PropertyWidgetType;
+}
+/** @public */
+export interface MetadataTypeManagerTypesRecord extends Record<string, PropertyWidgetEntry> {
 }
 /** @public */
 export interface MetadataTypeManager extends Events {
@@ -6651,43 +6656,535 @@ declare module "obsidian" {
 		setSize(size: number): void;
 	}
 }
-/** @public */
-export interface ElectronWindow extends BrowserWindow {
-	_browserViews: unknown;
-	_events: unknown;
-	_eventsCount: unknown;
-	devToolsWebContents: unknown;
-}
-/** @public */
-export interface FrameDom {
-	eWin: Electron.BrowserWindow;
-	isMac: boolean;
-	leftButtonContainerEl: HTMLDivElement;
-	titleBarEl: HTMLDivElement;
-	titleBarInnerEl: HTMLDivElement;
-	titleBarTextEl: HTMLDivElement;
-	win: Window;
-	updateStatus(): void;
-	updateTitle(): void;
+declare module "obsidian" {
+	interface TextFileView extends EditableFileView {
+		/**
+		 * Whether current file is dirty (different from saved contents)
+		 */
+		dirty: boolean;
+		/**
+		 * Whether editor should be rendered as plaintext
+		 */
+		isPlaintext: boolean;
+		/**
+		 * The data that was last saved
+		 */
+		lastSavedData: null | string;
+		/**
+		 * Whether on saving, the file should be saved again (for dirtiness checks)
+		 */
+		saveAgain: boolean;
+		/**
+		 * Whether the file is currently saving
+		 */
+		saving: boolean;
+		/** @todo Documentation incomplete */
+		loadFileInternal(file: TFile, clear: boolean): Promise<unknown>;
+		/**
+		 * Is called when the vault has a 'modify' event. Reloads the file if the view is currently not saving the file and the modified file is the file in this view.
+		 * @param file The modified file
+		 */
+		onModify(file: TFile): void;
+		/**
+		 * Saves the opened file
+		 * @param clear If set clears the editor under certain conditions
+		 */
+		save(clear?: boolean): Promise<void>;
+		/**
+		 * If any changes(dirty = true) in the file forces the file to save
+		 */
+		saveImmediately(): void;
+		/**
+		 * Set the data to the editor. This is used to load the file contents.
+		 * @param data The new data
+		 * @param clear If clear is set, then it means we're opening a completely different file. In that case, you should call clear(), or implement a slightly more efficient clearing mechanism given the new data to be set.
+		 */
+		setData(data: string, clear: boolean): void;
+	}
 }
-/** @public */
-export interface Localization {
-	[key: string]: string | Localization;
+declare module "obsidian" {
+	/** @todo Documentation incomplete */
+	interface View extends Component {
+		app: App;
+		/**
+		 * Whether the leaf may close the view
+		 */
+		closeable: boolean;
+		containerEl: HTMLElement;
+		/**
+		 * The icon string
+		 */
+		icon: IconName;
+		leaf: WorkspaceLeaf;
+		/**
+		 * Closes the view
+		 */
+		close(): Promise<void>;
+		/**
+		 * Gets the ephemeral (non-persistent) state of the editor
+		 */
+		getEphemeralState(): {};
+		/**
+		 * Returns the icon name
+		 */
+		getIcon(): IconName;
+		/**
+		 * Returns the placement of the tooltip
+		 */
+		getSideTooltipPlacement(): "left" | "right" | undefined;
+		/**
+		 * Returns the current state of the view
+		 */
+		getState(): {};
+		/**
+		 * Handle copy event on metadata editor and serialize properties
+		 */
+		handleCopy(event: ClipboardEvent): void;
+		/**
+		 * Handle cut event on metadata editor and serialize and remove properties
+		 */
+		handleCut(event: ClipboardEvent): void;
+		/**
+		 * Handle paste event of properties on metadata editor
+		 */
+		handlePaste(event: ClipboardEvent): void;
+		/** @deprecated use `onPaneMenu` instead */
+		onHeaderMenu(e: unknown): void;
+		/**
+		 * Adds the menu items to the menu
+		 * @param menu the menu to fill
+		 */
+		onTabMenu(menu: Menu): void;
+		/**
+		 * Opens the view
+		 * @param parentEl The node the view get attached to
+		 */
+		open(parentEl: Node): Promise<void>;
+		/**
+		 * Set the ephemeral (non-persistent) state of the editor
+		 */
+		setEphemeralState(state: any & {
+			focus: boolean;
+			focusOnMobile: boolean;
+			cursor: EditorRangeOrCaret;
+		}): void;
+		/** @todo Documentation incomplete */
+		setState(state: any, result: ViewStateResult): Promise<void>;
+	}
 }
-/** @public */
-export interface SQLError {
-	code: number;
-	message: string;
+declare module "obsidian" {
+	interface EditableFileView extends FileView {
+		/**
+		 * The file that is currently being renamed
+		 */
+		fileBeingRenamed: null | TFile;
+		/**
+		 * Is called when the titleEl looses focus
+		 * Event type: 'blur'
+		 */
+		onTitleBlur(): Promise<void>;
+		/**
+		 * Is called when the titleEl is changed
+		 * Event type: 'input'
+		 * @param titleEl The titleEl of the view
+		 */
+		onTitleChange(titleEl: HTMLElement): void;
+		/**
+		 * Is called when the titleEl gains focus
+		 * Event type: 'focus'
+		 */
+		onTitleFocus(): void;
+		/**
+		 * Is called when the titleEl is focused and a keydown is triggered
+		 * Event type: 'keydown'
+		 * @param event The KeyboardEvent which triggered this function
+		 */
+		onTitleKeydown(event: KeyboardEvent): void;
+		/**
+		 * Is called when the titleEl is focused and a paste event is triggered
+		 * Event type: 'paste'
+		 * @param titleEl The titleEl of the view
+		 * @param event The ClipboardEvent which triggered this function
+		 */
+		onTitlePaste(titleEl: HTMLElement, event: ClipboardEvent): void;
+		/**
+		 * Updates the file to match the updated title
+		 * @param titleEl The current titleEl
+		 */
+		saveTitle(titleEl: HTMLElement): Promise<void>;
+	}
 }
-/** @public */
-export interface SQLResultSetRowList {
-	length: number;
-	item(index: number): any;
+declare module "obsidian" {
+	/** @todo Documentation incomplete */
+	interface ItemView extends View {
+		/**
+		 * Container of actions for the view
+		 */
+		actionsEl: HTMLElement;
+		/**
+		 * Back button element for changing view history
+		 */
+		backButtonEl: HTMLButtonElement;
+		/**
+		 * Whether the view may be dropped anywhere in workspace
+		 */
+		canDropAnywhere: boolean;
+		/**
+		 * Forward button element for changing view history
+		 */
+		forwardButtonEl: HTMLButtonElement;
+		/**
+		 * Header bar container of view
+		 */
+		headerEl: HTMLElement;
+		/**
+		 * Icon element for the view (for dragging)
+		 */
+		iconEl: HTMLElement;
+		/**
+		 * Anchor button for revealing more view actions
+		 */
+		moreOptionsButtonEl: HTMLAnchorElement;
+		/**
+		 * Container for the title of the view
+		 */
+		titleContainerEl: HTMLElement;
+		/**
+		 * Title element for the view
+		 */
+		titleEl: HTMLElement;
+		/**
+		 * Title of the parent
+		 *
+		 * @remark Used for breadcrumbs rendering
+		 */
+		titleParentEl: HTMLElement;
+		/**
+		 * Adds an action button to the header of the view
+		 * @param icon - The icon for the action
+		 * @param title - The title for the action
+		 * @param callback - Callback to execute on click
+		 */
+		addAction(icon: IconName, title: string, callback: (evt: MouseEvent) => any): HTMLElement;
+		/** @todo Documentation incomplete */
+		handleDrop(event: DragEvent, t: unknown, n: unknown): unknown;
+		/** @todo Documentation incomplete */
+		onGroupChange(): void;
+		/** @todo Documentation incomplete */
+		onMoreOptions(event: Event): void;
+		/** @deprecated use onPaneMenu instead */
+		onMoreOptionsMenu(e: unknown): void;
+		/**
+		 * Updates the navigation buttons depending on the history
+		 */
+		updateNavButtons(): void;
+	}
 }
-/** @public */
-export interface SQLResultSet {
-	insertId: number;
-	rows: SQLResultSetRowList;
+declare module "obsidian" {
+	interface MarkdownView extends TextFileView {
+		/**
+		 * Backlinks component
+		 * @todo Documentation incomplete
+		 */
+		backlinks: null | unknown;
+		/**
+		 * The embedded backlinks element for the current file
+		 */
+		backlinksEl: HTMLElement;
+		/**
+		 * The currently active markdown view (preview or edit view)
+		 */
+		currentMode: MarkdownSubView;
+		/**
+		 * Editor component of the view
+		 */
+		editMode: MarkdownEditView;
+		/**
+		 * Editable title element of the view
+		 */
+		inlineTitleEl: HTMLElement;
+		/**
+		 * Frontmatter editor of the editor
+		 */
+		metadataEditor: MetadataEditor;
+		/**
+		 * Button for switching between different modes of the view
+		 */
+		modeButtonEl: HTMLAnchorElement;
+		/**
+		 * The registered modes of the view
+		 */
+		modes: {
+			source: MarkdownEditView;
+			preview: MarkdownPreviewView;
+		};
+		/**
+		 * Preview component of the view
+		 */
+		previewMode: MarkdownPreviewView;
+		/**
+		 * File frontmatter as a raw string
+		 */
+		rawFrontmatter: string;
+		/**
+		 * Current scroll position of the editor
+		 */
+		scroll: null | number;
+		/**
+		 * Whether to show backlinks in the editor
+		 */
+		showBacklinks: boolean;
+		/** @deprecated CM5 Editor */
+		sourceMode: {
+			cmEditor: any;
+		};
+		/**
+		 * Add property to inline metadata editor or properties plugin
+		 *
+		 * @deprecated Removed in 1.6.0
+		 * @remark Parameter is not used
+		 */
+		addProperty(unused: undefined): void;
+		/**
+		 * Whether the editor can render properties according to the current mode and config
+		 */
+		canShowProperties(): boolean;
+		/**
+		 * Whether the editor can toggle backlinks according to current mode
+		 */
+		canToggleBacklinks(): boolean;
+		/**
+		 * Collapse the properties editor
+		 */
+		collapseProperties(collapse: boolean): void;
+		/**
+		 * Edit the focused property in the metadata editor
+		 *
+		 * @remark Parameter is not used
+		 */
+		editProperty(unused: undefined): void;
+		/**
+		 * Focus on the metadata editor given property information
+		 */
+		focusMetadata(focus?: {
+			focusHeading: boolean;
+			propertyIdx?: number;
+			propertyKey?: string;
+		}): void;
+		/**
+		 * Gets the ephemeral (non-persistent) state of the editor
+		 */
+		getEphemeralState(): any & {
+			scroll: number;
+		};
+		/**
+		 * Get the file attached to the view
+		 */
+		getFile(): TFile | null;
+		/** @internal Get the current mode of the editor */
+		getHoverSource(): string;
+		/**
+		 * Get the current mode of the editor
+		 */
+		getMode(): MarkdownViewModeType;
+		/**
+		 * Get selection of current mode
+		 */
+		getSelection(): string;
+		/**
+		 * Get the current view type
+		 */
+		getViewType(): "markdown";
+		/**
+		 * Validate correctness of frontmatter and update metadata editor
+		 */
+		loadFrontmatter(data: string): void;
+		/**
+		 * Whether the metadata editor has focus
+		 */
+		metadataHasFocus(): boolean;
+		/**
+		 * On app css change, update source mode editor
+		 */
+		onCssChange(): void;
+		/**
+		 * Update editor on external data change (from sync plugin)
+		 */
+		onExternalDataChange(file: TFile, data: string): void;
+		/**
+		 * On blur of inline title, save new filename
+		 */
+		onInlineTitleBlur(): Promise<void>;
+		/**
+		 * On data change of editor, update internal data and metadata editor
+		 */
+		onInternalDataChange(): void;
+		/**
+		 * On loading markdown view, register resize, css-change and quick-preview events
+		 */
+		onload(): void;
+		/**
+		 * On fold of markdown in source editor, save fold info to fold manager
+		 */
+		onMarkdownFold(): void;
+		/**
+		 * On markdown scroll in editors, update scroll, sync state and trigger markdown scroll event
+		 */
+		onMarkdownScroll(): void;
+		/**
+		 * On mod click, opens editor of opposite mode in split view to right
+		 */
+		onSwitchView(event: KeyboardEvent | MouseEvent): Promise<void>;
+		/**
+		 * Opens PDF modal for exporting PDF of the current file
+		 */
+		printToPdf(): void;
+		/**
+		 * Redo action of source mode editor
+		 */
+		redo(): void;
+		/**
+		 * Register editor mode component to view
+		 */
+		registerMode(component: MarkdownSubView): void;
+		/**
+		 * Save the frontmatter of the file
+		 */
+		saveFrontmatter(properties: Record<string, any>): void;
+		/**
+		 * Set the mode of the editor
+		 */
+		setMode(component: MarkdownSubView): Promise<void>;
+		/**
+		 * Shift focus to first line of editor
+		 */
+		shiftFocusAfter(): void;
+		/**
+		 * Shift focus to inline title
+		 */
+		shiftFocusBefore(): void;
+		/**
+		 * Toggle backlinks on editor
+		 */
+		toggleBacklinks(): Promise<void>;
+		/**
+		 * Toggle collapse status of properties editor if allowed
+		 */
+		toggleCollapseProperties(): void;
+		/**
+		 * Toggle between source and preview mode
+		 */
+		toggleMode(): void;
+		/**
+		 * Execute functionality of token (open external link, open internal link in leaf, ...)
+		 */
+		triggerClickableToken(token: Token, new_leaf: boolean): void;
+		/**
+		 * Undo action of source mode editor
+		 */
+		undo(): void;
+		/**
+		 * Update the backlinks component for new file
+		 */
+		updateBacklinks(): void;
+		/**
+		 * Update reading/source view action buttons of modeButtonEl with current mode
+		 */
+		updateButtons(): void;
+		/**
+		 * Update options of the editors from settings
+		 */
+		updateOptions(): void;
+		/**
+		 * Hide/render backlinks component
+		 */
+		updateShowBacklinks(): void;
+	}
+}
+declare module "obsidian" {
+	/** @todo Documentation incomplete */
+	interface FileView extends ItemView {
+		/**
+		 * Whether the view may be run without an attached file
+		 */
+		allowNoFile: boolean;
+		/**
+		 * Determines whether the specified file extension can be opened in this view.
+		 * @param extension The file extension to be evaluated
+		 */
+		canAcceptExtension(extension: string): boolean;
+		/**
+		 * Get view state for sync plugin
+		 */
+		getSyncViewState(): any;
+		/**
+		 * Loads the file with the onLoadFile function
+		 * @param file The File to load
+		 */
+		loadFile(file: TFile): Promise<unknown>;
+		/**
+		 * Updates the view if it contains the deleted file
+		 * @param file The file that is deleted
+		 */
+		onDelete(file: TFile): Promise<void>;
+		/**
+		 * Is called when a file get loaded
+		 * @param file The file that is loaded
+		 */
+		onLoadFile(file: TFile): Promise<void>;
+		/**
+		 * Updates the view information based on the new file name
+		 * @param file The file that is renamed
+		 */
+		onRename(file: TFile): Promise<void>;
+		/**
+		 * Is called when a file get unloaded
+		 * @param file The file that is unloaded
+		 */
+		onUnloadFile(file: TFile): Promise<void>;
+		/** @todo Documentation incomplete */
+		renderBreadcrumbs(): void;
+		/** @todo Documentation incomplete */
+		syncState(e: boolean): Promise<unknown>;
+	}
+}
+/** @public */
+export interface ElectronWindow extends BrowserWindow {
+	_browserViews: unknown;
+	_events: unknown;
+	_eventsCount: unknown;
+	devToolsWebContents: unknown;
+}
+/** @public */
+export interface FrameDom {
+	eWin: Electron.BrowserWindow;
+	isMac: boolean;
+	leftButtonContainerEl: HTMLDivElement;
+	titleBarEl: HTMLDivElement;
+	titleBarInnerEl: HTMLDivElement;
+	titleBarTextEl: HTMLDivElement;
+	win: Window;
+	updateStatus(): void;
+	updateTitle(): void;
+}
+/** @public */
+export interface Localization {
+	[key: string]: string | Localization;
+}
+/** @public */
+export interface SQLError {
+	code: number;
+	message: string;
+}
+/** @public */
+export interface SQLResultSetRowList {
+	length: number;
+	item(index: number): any;
+}
+/** @public */
+export interface SQLResultSet {
+	insertId: number;
+	rows: SQLResultSetRowList;
 	rowsAffected: number;
 }
 /** @public */
@@ -6941,11 +7438,6 @@ declare global {
 	 */
 	var wf: typeof Object.defineProperty;
 }
-declare global {
-	interface DomElementInfo {
-		[eventName: `on${string}`]: EventListenerOrEventListenerObject;
-	}
-}
 /** @public */
 export interface IFramedMarkdownEditor extends MarkdownScrollableEditView {
 	/**
@@ -7049,764 +7541,277 @@ export interface EmbeddedEditorView extends Component {
 	 */
 	get scroll(): unknown;
 	/**
-	 * Destroy edit component editor and save contents if specified
-	 */
-	destroyEditor(save?: boolean): void;
-	/**
-	 * Gets currently active mode (editMode returns 'source')
-	 */
-	getMode(): "source" | "preview";
-	/**
-	 * On load of editor, show preview
-	 */
-	onload(): void;
-	/**
-	 * Trigger markdown scroll on workspace
-	 */
-	onMarkdownScroll(): void;
-	/**
-	 * On unload of editor, destroy editor and unset workspace activeEditor
-	 */
-	onunload(): void;
-	/**
-	 * Debounced save of contents
-	 */
-	requestSave(): void;
-	/**
-	 * Debounced save of editor folds
-	 */
-	requestSaveFolds(): void;
-	/**
-	 * Set file contents
-	 */
-	save(data: string, save?: boolean): void;
-	/**
-	 * Set the state of the editor
-	 */
-	set(data: string, clear: boolean): void;
-	/**
-	 * Reveal the editor if editable widget and applies saved state
-	 */
-	showEditor(): void;
-	/**
-	 * Reveal preview mode and destroy editor, save if specified
-	 */
-	showPreview(save?: boolean): void;
-	/**
-	 * Reveal search component in file renderer component
-	 */
-	showSearch(replace?: boolean): void;
-	/**
-	 * Toggle between edit and preview mode
-	 */
-	toggleMode(): void;
-}
-/** @public */
-export interface WidgetEditorView extends EmbeddedEditorView {
-	/**
-	 * Data after reference
-	 */
-	after: string;
-	/**
-	 * Data before reference
-	 */
-	before: string;
-	/**
-	 * Full file contents
-	 */
-	data: string;
-	/**
-	 * File being currently renamed
-	 */
-	fileBeingRenamed: null | TFile;
-	/**
-	 * Current heading
-	 */
-	heading: string;
-	/**
-	 * Indent
-	 */
-	indent: string;
-	/**
-	 * Inline title element
-	 */
-	inlineTitleEl: HTMLElement;
-	/**
-	 * Full inline content string
-	 */
-	lastSavedData: null | string;
-	/**
-	 * Whether embedding should be saved twice on save
-	 */
-	saveAgain: boolean;
-	/**
-	 * Whether the widget is currently saving
-	 */
-	saving: boolean;
-	/**
-	 * Subpath reference of the path
-	 */
-	subpath: string;
-	/**
-	 * Whether the subpath was not found in the cache
-	 */
-	subpathNotFound: boolean;
-	/**
-	 * Push/pop current scope
-	 */
-	applyScope(scope: Scope): void;
-	/**
-	 * Get the current folds of the editor
-	 */
-	getFoldInfo(): null | FoldInfo;
-	/**
-	 * Splice incoming data at according to subpath for correct reference, then update heading and render
-	 */
-	loadContents(data: string, cache: CachedMetadata): void;
-	/**
-	 * Load file from cache based on stored path
-	 */
-	loadFile(): Promise<void>;
-	/**
-	 * Load file and check if data is different from last saved data, then loads contents
-	 */
-	loadFileInternal(data: string, cache?: CachedMetadata): void;
-	/**
-	 * Update representation on file finished updating
-	 */
-	onFileChanged(file: TFile, data: string, cache: CachedMetadata): void;
-	/**
-	 * Update representation on file rename
-	 */
-	onFileRename(file: TAbstractFile, oldPath: string): void;
-	/**
-	 * On loading widget, register vault change and rename events
-	 */
-	onload(): void;
-	/**
-	 * Save fold made in the editor to foldManager
-	 */
-	onMarkdownFold(): void;
-	/** @internal On change of editor title element */
-	onTitleChange(element: HTMLElement): void;
-	/** @internal On keypress on editor title element */
-	onTitleKeydown(event: KeyboardEvent): void;
-	/** @internal On pasting on editor title element */
-	onTitlePaste(element: HTMLElement, event: ClipboardEvent): void;
-	/**
-	 * On unloading widget, unload component and remove scope
-	 */
-	onunload(): void;
-	/**
-	 * Save changes made in editable widget
-	 */
-	save(data: string, delayed?: boolean): Promise<void>;
-	/**
-	 * On blur widget, save title
-	 */
-	saveTitle(element: HTMLElement): void;
-	/**
-	 * Show preview of widget
-	 */
-	showPreview(show?: boolean): void;
-}
-/** @public */
-export interface CanvasLeaf extends WorkspaceLeaf {
-}
-/** @public */
-export interface FileSuggestManager {
-	/**
-	 * Reference to the app
-	 */
-	app: App;
-	/**
-	 * Selection of files and their paths that can be matched to
-	 */
-	fileSuggestions: null | {
-		file: TFile | null;
-		path: string;
-	}[];
-	/**
-	 * Whether search should be vault-wide rather than scoped to current file
-	 */
-	global: boolean;
-	/**
-	 * Type of suggestions that should be provided
-	 */
-	mode: "file" | "heading" | "block" | "display" | string;
-	/**
-	 * Executor of the search
-	 */
-	runnable: null | Runnable;
-	/**
-	 * Get suggestions for block query
-	 */
-	getBlockSuggestions(runner: Runnable, file: TFile, text: string): Promise<SearchResult[]>;
-	/**
-	 * Get suggestions for display alias query
-	 */
-	getDisplaySuggestions(runner: Runnable, linkpath: string, subpath: string, alias: string): Promise<SearchResult[]>;
-	/**
-	 * Get suggestions for file query
-	 */
-	getFileSuggestions(runner: Runnable, text: string): Promise<SearchResult[]>;
-	/**
-	 * Get suggestions for global block query
-	 */
-	getGlobalBlockSuggestions(runner: Runnable, text: string): Promise<SearchResult[]>;
-	/**
-	 * Get suggestions for global heading query
-	 */
-	getGlobalHeadingSuggestions(runner: Runnable, text: string): Promise<SearchResult[]>;
-	/**
-	 * Get suggestions for file heading query
-	 */
-	getHeadingSuggestions(runner: Runnable, file: TFile, text: string): Promise<SearchResult[]>;
-	/** @internal Generate instructions for specific actions in suggestion manager (e.g. accept, select, ...) */
-	getInstructions(): [
-		{
-			command: "string";
-			purpose: "string";
-		}
-	];
-	/**
-	 * Determine the source path of current context
-	 */
-	getSourcePath(): null | string;
-	/**
-	 * Get suggestions for current input text
-	 *
-	 * @remark Type is determined from text: e.g. [[Thi]] will give completions for files, [[Thi^]] for blocks, etc.
-	 */
-	getSuggestionsAsync(runner: Runnable, text: string): Promise<SearchResult[]>;
-	/**
-	 * Match search fragments to a block
-	 */
-	matchBlock(path: string, file: TFile, block: BlockCache, sourcePath: null | string, content: string, text_parts: string[]): SearchResult | null;
-}
-/** @todo Documentation incomplete */
-/** @public */
-export interface Account {
-	/**
-	 * The company associated with the activated commercial license
+	 * Destroy edit component editor and save contents if specified
 	 */
-	company: string;
+	destroyEditor(save?: boolean): void;
 	/**
-	 * The email address associated with the account
+	 * Gets currently active mode (editMode returns 'source')
 	 */
-	email: string;
-	expiry: number;
-	key: string | undefined;
-	keyValidation: string;
+	getMode(): "source" | "preview";
 	/**
-	 * The license available to the account
+	 * On load of editor, show preview
 	 */
-	license: "" | "insider";
+	onload(): void;
 	/**
-	 * Profile name
+	 * Trigger markdown scroll on workspace
 	 */
-	name: string;
-	seats: number;
-	token: string;
-}
-/** @todo Documentation incomplete */
-/** @public */
-export interface FileSuggest<T> extends EditorSuggest<T> {
+	onMarkdownScroll(): void;
 	/**
-	 * Manages fetching of suggestions from metadatacache
+	 * On unload of editor, destroy editor and unset workspace activeEditor
 	 */
-	suggestManager: FileSuggestManager;
-}
-declare module "obsidian" {
-	interface TextFileView extends EditableFileView {
-		/**
-		 * Whether current file is dirty (different from saved contents)
-		 */
-		dirty: boolean;
-		/**
-		 * Whether editor should be rendered as plaintext
-		 */
-		isPlaintext: boolean;
-		/**
-		 * The data that was last saved
-		 */
-		lastSavedData: null | string;
-		/**
-		 * Whether on saving, the file should be saved again (for dirtiness checks)
-		 */
-		saveAgain: boolean;
-		/**
-		 * Whether the file is currently saving
-		 */
-		saving: boolean;
-		/** @todo Documentation incomplete */
-		loadFileInternal(file: TFile, clear: boolean): Promise<unknown>;
-		/**
-		 * Is called when the vault has a 'modify' event. Reloads the file if the view is currently not saving the file and the modified file is the file in this view.
-		 * @param file The modified file
-		 */
-		onModify(file: TFile): void;
-		/**
-		 * Saves the opened file
-		 * @param clear If set clears the editor under certain conditions
-		 */
-		save(clear?: boolean): Promise<void>;
-		/**
-		 * If any changes(dirty = true) in the file forces the file to save
-		 */
-		saveImmediately(): void;
-		/**
-		 * Set the data to the editor. This is used to load the file contents.
-		 * @param data The new data
-		 * @param clear If clear is set, then it means we're opening a completely different file. In that case, you should call clear(), or implement a slightly more efficient clearing mechanism given the new data to be set.
-		 */
-		setData(data: string, clear: boolean): void;
-	}
-}
-declare module "obsidian" {
-	/** @todo Documentation incomplete */
-	interface View extends Component {
-		app: App;
-		/**
-		 * Whether the leaf may close the view
-		 */
-		closeable: boolean;
-		containerEl: HTMLElement;
-		/**
-		 * The icon string
-		 */
-		icon: IconName;
-		leaf: WorkspaceLeaf;
-		/**
-		 * Closes the view
-		 */
-		close(): Promise<void>;
-		/**
-		 * Gets the ephemeral (non-persistent) state of the editor
-		 */
-		getEphemeralState(): {};
-		/**
-		 * Returns the icon name
-		 */
-		getIcon(): IconName;
-		/**
-		 * Returns the placement of the tooltip
-		 */
-		getSideTooltipPlacement(): "left" | "right" | undefined;
-		/**
-		 * Returns the current state of the view
-		 */
-		getState(): {};
-		/**
-		 * Handle copy event on metadata editor and serialize properties
-		 */
-		handleCopy(event: ClipboardEvent): void;
-		/**
-		 * Handle cut event on metadata editor and serialize and remove properties
-		 */
-		handleCut(event: ClipboardEvent): void;
-		/**
-		 * Handle paste event of properties on metadata editor
-		 */
-		handlePaste(event: ClipboardEvent): void;
-		/** @deprecated use `onPaneMenu` instead */
-		onHeaderMenu(e: unknown): void;
-		/**
-		 * Adds the menu items to the menu
-		 * @param menu the menu to fill
-		 */
-		onTabMenu(menu: Menu): void;
-		/**
-		 * Opens the view
-		 * @param parentEl The node the view get attached to
-		 */
-		open(parentEl: Node): Promise<void>;
-		/**
-		 * Set the ephemeral (non-persistent) state of the editor
-		 */
-		setEphemeralState(state: any & {
-			focus: boolean;
-			focusOnMobile: boolean;
-			cursor: EditorRangeOrCaret;
-		}): void;
-		/** @todo Documentation incomplete */
-		setState(state: any, result: ViewStateResult): Promise<void>;
-	}
-}
-declare module "obsidian" {
-	interface EditableFileView extends FileView {
-		/**
-		 * The file that is currently being renamed
-		 */
-		fileBeingRenamed: null | TFile;
-		/**
-		 * Is called when the titleEl looses focus
-		 * Event type: 'blur'
-		 */
-		onTitleBlur(): Promise<void>;
-		/**
-		 * Is called when the titleEl is changed
-		 * Event type: 'input'
-		 * @param titleEl The titleEl of the view
-		 */
-		onTitleChange(titleEl: HTMLElement): void;
-		/**
-		 * Is called when the titleEl gains focus
-		 * Event type: 'focus'
-		 */
-		onTitleFocus(): void;
-		/**
-		 * Is called when the titleEl is focused and a keydown is triggered
-		 * Event type: 'keydown'
-		 * @param event The KeyboardEvent which triggered this function
-		 */
-		onTitleKeydown(event: KeyboardEvent): void;
-		/**
-		 * Is called when the titleEl is focused and a paste event is triggered
-		 * Event type: 'paste'
-		 * @param titleEl The titleEl of the view
-		 * @param event The ClipboardEvent which triggered this function
-		 */
-		onTitlePaste(titleEl: HTMLElement, event: ClipboardEvent): void;
-		/**
-		 * Updates the file to match the updated title
-		 * @param titleEl The current titleEl
-		 */
-		saveTitle(titleEl: HTMLElement): Promise<void>;
-	}
-}
-declare module "obsidian" {
-	/** @todo Documentation incomplete */
-	interface ItemView extends View {
-		/**
-		 * Container of actions for the view
-		 */
-		actionsEl: HTMLElement;
-		/**
-		 * Back button element for changing view history
-		 */
-		backButtonEl: HTMLButtonElement;
-		/**
-		 * Whether the view may be dropped anywhere in workspace
-		 */
-		canDropAnywhere: boolean;
-		/**
-		 * Forward button element for changing view history
-		 */
-		forwardButtonEl: HTMLButtonElement;
-		/**
-		 * Header bar container of view
-		 */
-		headerEl: HTMLElement;
-		/**
-		 * Icon element for the view (for dragging)
-		 */
-		iconEl: HTMLElement;
-		/**
-		 * Anchor button for revealing more view actions
-		 */
-		moreOptionsButtonEl: HTMLAnchorElement;
-		/**
-		 * Container for the title of the view
-		 */
-		titleContainerEl: HTMLElement;
-		/**
-		 * Title element for the view
-		 */
-		titleEl: HTMLElement;
-		/**
-		 * Title of the parent
-		 *
-		 * @remark Used for breadcrumbs rendering
-		 */
-		titleParentEl: HTMLElement;
-		/**
-		 * Adds an action button to the header of the view
-		 * @param icon - The icon for the action
-		 * @param title - The title for the action
-		 * @param callback - Callback to execute on click
-		 */
-		addAction(icon: IconName, title: string, callback: (evt: MouseEvent) => any): HTMLElement;
-		/** @todo Documentation incomplete */
-		handleDrop(event: DragEvent, t: unknown, n: unknown): unknown;
-		/** @todo Documentation incomplete */
-		onGroupChange(): void;
-		/** @todo Documentation incomplete */
-		onMoreOptions(event: Event): void;
-		/** @deprecated use onPaneMenu instead */
-		onMoreOptionsMenu(e: unknown): void;
-		/**
-		 * Updates the navigation buttons depending on the history
-		 */
-		updateNavButtons(): void;
-	}
+	onunload(): void;
+	/**
+	 * Debounced save of contents
+	 */
+	requestSave(): void;
+	/**
+	 * Debounced save of editor folds
+	 */
+	requestSaveFolds(): void;
+	/**
+	 * Set file contents
+	 */
+	save(data: string, save?: boolean): void;
+	/**
+	 * Set the state of the editor
+	 */
+	set(data: string, clear: boolean): void;
+	/**
+	 * Reveal the editor if editable widget and applies saved state
+	 */
+	showEditor(): void;
+	/**
+	 * Reveal preview mode and destroy editor, save if specified
+	 */
+	showPreview(save?: boolean): void;
+	/**
+	 * Reveal search component in file renderer component
+	 */
+	showSearch(replace?: boolean): void;
+	/**
+	 * Toggle between edit and preview mode
+	 */
+	toggleMode(): void;
 }
-declare module "obsidian" {
-	interface MarkdownView extends TextFileView {
-		/**
-		 * Backlinks component
-		 * @todo Documentation incomplete
-		 */
-		backlinks: null | unknown;
-		/**
-		 * The embedded backlinks element for the current file
-		 */
-		backlinksEl: HTMLElement;
-		/**
-		 * The currently active markdown view (preview or edit view)
-		 */
-		currentMode: MarkdownSubView;
-		/**
-		 * Editor component of the view
-		 */
-		editMode: MarkdownEditView;
-		/**
-		 * Editable title element of the view
-		 */
-		inlineTitleEl: HTMLElement;
-		/**
-		 * Frontmatter editor of the editor
-		 */
-		metadataEditor: MetadataEditor;
-		/**
-		 * Button for switching between different modes of the view
-		 */
-		modeButtonEl: HTMLAnchorElement;
-		/**
-		 * The registered modes of the view
-		 */
-		modes: {
-			source: MarkdownEditView;
-			preview: MarkdownPreviewView;
-		};
-		/**
-		 * Preview component of the view
-		 */
-		previewMode: MarkdownPreviewView;
-		/**
-		 * File frontmatter as a raw string
-		 */
-		rawFrontmatter: string;
-		/**
-		 * Current scroll position of the editor
-		 */
-		scroll: null | number;
-		/**
-		 * Whether to show backlinks in the editor
-		 */
-		showBacklinks: boolean;
-		/** @deprecated CM5 Editor */
-		sourceMode: {
-			cmEditor: any;
-		};
-		/**
-		 * Add property to inline metadata editor or properties plugin
-		 *
-		 * @deprecated Removed in 1.6.0
-		 * @remark Parameter is not used
-		 */
-		addProperty(unused: undefined): void;
-		/**
-		 * Whether the editor can render properties according to the current mode and config
-		 */
-		canShowProperties(): boolean;
-		/**
-		 * Whether the editor can toggle backlinks according to current mode
-		 */
-		canToggleBacklinks(): boolean;
-		/**
-		 * Collapse the properties editor
-		 */
-		collapseProperties(collapse: boolean): void;
-		/**
-		 * Edit the focused property in the metadata editor
-		 *
-		 * @remark Parameter is not used
-		 */
-		editProperty(unused: undefined): void;
-		/**
-		 * Focus on the metadata editor given property information
-		 */
-		focusMetadata(focus?: {
-			focusHeading: boolean;
-			propertyIdx?: number;
-			propertyKey?: string;
-		}): void;
-		/**
-		 * Gets the ephemeral (non-persistent) state of the editor
-		 */
-		getEphemeralState(): any & {
-			scroll: number;
-		};
-		/**
-		 * Get the file attached to the view
-		 */
-		getFile(): TFile | null;
-		/** @internal Get the current mode of the editor */
-		getHoverSource(): string;
-		/**
-		 * Get the current mode of the editor
-		 */
-		getMode(): MarkdownViewModeType;
-		/**
-		 * Get selection of current mode
-		 */
-		getSelection(): string;
-		/**
-		 * Get the current view type
-		 */
-		getViewType(): "markdown";
-		/**
-		 * Validate correctness of frontmatter and update metadata editor
-		 */
-		loadFrontmatter(data: string): void;
-		/**
-		 * Whether the metadata editor has focus
-		 */
-		metadataHasFocus(): boolean;
-		/**
-		 * On app css change, update source mode editor
-		 */
-		onCssChange(): void;
-		/**
-		 * Update editor on external data change (from sync plugin)
-		 */
-		onExternalDataChange(file: TFile, data: string): void;
-		/**
-		 * On blur of inline title, save new filename
-		 */
-		onInlineTitleBlur(): Promise<void>;
-		/**
-		 * On data change of editor, update internal data and metadata editor
-		 */
-		onInternalDataChange(): void;
-		/**
-		 * On loading markdown view, register resize, css-change and quick-preview events
-		 */
-		onload(): void;
-		/**
-		 * On fold of markdown in source editor, save fold info to fold manager
-		 */
-		onMarkdownFold(): void;
-		/**
-		 * On markdown scroll in editors, update scroll, sync state and trigger markdown scroll event
-		 */
-		onMarkdownScroll(): void;
-		/**
-		 * On mod click, opens editor of opposite mode in split view to right
-		 */
-		onSwitchView(event: KeyboardEvent | MouseEvent): Promise<void>;
-		/**
-		 * Opens PDF modal for exporting PDF of the current file
-		 */
-		printToPdf(): void;
-		/**
-		 * Redo action of source mode editor
-		 */
-		redo(): void;
-		/**
-		 * Register editor mode component to view
-		 */
-		registerMode(component: MarkdownSubView): void;
-		/**
-		 * Save the frontmatter of the file
-		 */
-		saveFrontmatter(properties: Record<string, any>): void;
-		/**
-		 * Set the mode of the editor
-		 */
-		setMode(component: MarkdownSubView): Promise<void>;
-		/**
-		 * Shift focus to first line of editor
-		 */
-		shiftFocusAfter(): void;
-		/**
-		 * Shift focus to inline title
-		 */
-		shiftFocusBefore(): void;
-		/**
-		 * Toggle backlinks on editor
-		 */
-		toggleBacklinks(): Promise<void>;
-		/**
-		 * Toggle collapse status of properties editor if allowed
-		 */
-		toggleCollapseProperties(): void;
-		/**
-		 * Toggle between source and preview mode
-		 */
-		toggleMode(): void;
-		/**
-		 * Execute functionality of token (open external link, open internal link in leaf, ...)
-		 */
-		triggerClickableToken(token: Token, new_leaf: boolean): void;
-		/**
-		 * Undo action of source mode editor
-		 */
-		undo(): void;
-		/**
-		 * Update the backlinks component for new file
-		 */
-		updateBacklinks(): void;
-		/**
-		 * Update reading/source view action buttons of modeButtonEl with current mode
-		 */
-		updateButtons(): void;
-		/**
-		 * Update options of the editors from settings
-		 */
-		updateOptions(): void;
-		/**
-		 * Hide/render backlinks component
-		 */
-		updateShowBacklinks(): void;
-	}
+/** @public */
+export interface WidgetEditorView extends EmbeddedEditorView {
+	/**
+	 * Data after reference
+	 */
+	after: string;
+	/**
+	 * Data before reference
+	 */
+	before: string;
+	/**
+	 * Full file contents
+	 */
+	data: string;
+	/**
+	 * File being currently renamed
+	 */
+	fileBeingRenamed: null | TFile;
+	/**
+	 * Current heading
+	 */
+	heading: string;
+	/**
+	 * Indent
+	 */
+	indent: string;
+	/**
+	 * Inline title element
+	 */
+	inlineTitleEl: HTMLElement;
+	/**
+	 * Full inline content string
+	 */
+	lastSavedData: null | string;
+	/**
+	 * Whether embedding should be saved twice on save
+	 */
+	saveAgain: boolean;
+	/**
+	 * Whether the widget is currently saving
+	 */
+	saving: boolean;
+	/**
+	 * Subpath reference of the path
+	 */
+	subpath: string;
+	/**
+	 * Whether the subpath was not found in the cache
+	 */
+	subpathNotFound: boolean;
+	/**
+	 * Push/pop current scope
+	 */
+	applyScope(scope: Scope): void;
+	/**
+	 * Get the current folds of the editor
+	 */
+	getFoldInfo(): null | FoldInfo;
+	/**
+	 * Splice incoming data at according to subpath for correct reference, then update heading and render
+	 */
+	loadContents(data: string, cache: CachedMetadata): void;
+	/**
+	 * Load file from cache based on stored path
+	 */
+	loadFile(): Promise<void>;
+	/**
+	 * Load file and check if data is different from last saved data, then loads contents
+	 */
+	loadFileInternal(data: string, cache?: CachedMetadata): void;
+	/**
+	 * Update representation on file finished updating
+	 */
+	onFileChanged(file: TFile, data: string, cache: CachedMetadata): void;
+	/**
+	 * Update representation on file rename
+	 */
+	onFileRename(file: TAbstractFile, oldPath: string): void;
+	/**
+	 * On loading widget, register vault change and rename events
+	 */
+	onload(): void;
+	/**
+	 * Save fold made in the editor to foldManager
+	 */
+	onMarkdownFold(): void;
+	/** @internal On change of editor title element */
+	onTitleChange(element: HTMLElement): void;
+	/** @internal On keypress on editor title element */
+	onTitleKeydown(event: KeyboardEvent): void;
+	/** @internal On pasting on editor title element */
+	onTitlePaste(element: HTMLElement, event: ClipboardEvent): void;
+	/**
+	 * On unloading widget, unload component and remove scope
+	 */
+	onunload(): void;
+	/**
+	 * Save changes made in editable widget
+	 */
+	save(data: string, delayed?: boolean): Promise<void>;
+	/**
+	 * On blur widget, save title
+	 */
+	saveTitle(element: HTMLElement): void;
+	/**
+	 * Show preview of widget
+	 */
+	showPreview(show?: boolean): void;
 }
-declare module "obsidian" {
-	/** @todo Documentation incomplete */
-	interface FileView extends ItemView {
-		/**
-		 * Whether the view may be run without an attached file
-		 */
-		allowNoFile: boolean;
-		/**
-		 * Determines whether the specified file extension can be opened in this view.
-		 * @param extension The file extension to be evaluated
-		 */
-		canAcceptExtension(extension: string): boolean;
-		/**
-		 * Get view state for sync plugin
-		 */
-		getSyncViewState(): any;
-		/**
-		 * Loads the file with the onLoadFile function
-		 * @param file The File to load
-		 */
-		loadFile(file: TFile): Promise<unknown>;
-		/**
-		 * Updates the view if it contains the deleted file
-		 * @param file The file that is deleted
-		 */
-		onDelete(file: TFile): Promise<void>;
-		/**
-		 * Is called when a file get loaded
-		 * @param file The file that is loaded
-		 */
-		onLoadFile(file: TFile): Promise<void>;
-		/**
-		 * Updates the view information based on the new file name
-		 * @param file The file that is renamed
-		 */
-		onRename(file: TFile): Promise<void>;
-		/**
-		 * Is called when a file get unloaded
-		 * @param file The file that is unloaded
-		 */
-		onUnloadFile(file: TFile): Promise<void>;
-		/** @todo Documentation incomplete */
-		renderBreadcrumbs(): void;
-		/** @todo Documentation incomplete */
-		syncState(e: boolean): Promise<unknown>;
+/** @public */
+export interface CanvasLeaf extends WorkspaceLeaf {
+}
+/** @public */
+export interface FileSuggestManager {
+	/**
+	 * Reference to the app
+	 */
+	app: App;
+	/**
+	 * Selection of files and their paths that can be matched to
+	 */
+	fileSuggestions: null | {
+		file: TFile | null;
+		path: string;
+	}[];
+	/**
+	 * Whether search should be vault-wide rather than scoped to current file
+	 */
+	global: boolean;
+	/**
+	 * Type of suggestions that should be provided
+	 */
+	mode: "file" | "heading" | "block" | "display" | string;
+	/**
+	 * Executor of the search
+	 */
+	runnable: null | Runnable;
+	/**
+	 * Get suggestions for block query
+	 */
+	getBlockSuggestions(runner: Runnable, file: TFile, text: string): Promise<SearchResult[]>;
+	/**
+	 * Get suggestions for display alias query
+	 */
+	getDisplaySuggestions(runner: Runnable, linkpath: string, subpath: string, alias: string): Promise<SearchResult[]>;
+	/**
+	 * Get suggestions for file query
+	 */
+	getFileSuggestions(runner: Runnable, text: string): Promise<SearchResult[]>;
+	/**
+	 * Get suggestions for global block query
+	 */
+	getGlobalBlockSuggestions(runner: Runnable, text: string): Promise<SearchResult[]>;
+	/**
+	 * Get suggestions for global heading query
+	 */
+	getGlobalHeadingSuggestions(runner: Runnable, text: string): Promise<SearchResult[]>;
+	/**
+	 * Get suggestions for file heading query
+	 */
+	getHeadingSuggestions(runner: Runnable, file: TFile, text: string): Promise<SearchResult[]>;
+	/** @internal Generate instructions for specific actions in suggestion manager (e.g. accept, select, ...) */
+	getInstructions(): [
+		{
+			command: "string";
+			purpose: "string";
+		}
+	];
+	/**
+	 * Determine the source path of current context
+	 */
+	getSourcePath(): null | string;
+	/**
+	 * Get suggestions for current input text
+	 *
+	 * @remark Type is determined from text: e.g. [[Thi]] will give completions for files, [[Thi^]] for blocks, etc.
+	 */
+	getSuggestionsAsync(runner: Runnable, text: string): Promise<SearchResult[]>;
+	/**
+	 * Match search fragments to a block
+	 */
+	matchBlock(path: string, file: TFile, block: BlockCache, sourcePath: null | string, content: string, text_parts: string[]): SearchResult | null;
+}
+/** @todo Documentation incomplete */
+/** @public */
+export interface Account {
+	/**
+	 * The company associated with the activated commercial license
+	 */
+	company: string;
+	/**
+	 * The email address associated with the account
+	 */
+	email: string;
+	expiry: number;
+	key: string | undefined;
+	keyValidation: string;
+	/**
+	 * The license available to the account
+	 */
+	license: "" | "insider";
+	/**
+	 * Profile name
+	 */
+	name: string;
+	seats: number;
+	token: string;
+}
+/** @todo Documentation incomplete */
+/** @public */
+export interface FileSuggest<T> extends EditorSuggest<T> {
+	/**
+	 * Manages fetching of suggestions from metadatacache
+	 */
+	suggestManager: FileSuggestManager;
+}
+declare global {
+	interface DomElementInfo {
+		[eventName: `on${string}`]: EventListenerOrEventListenerObject;
 	}
 }
 /** @todo Documentation incomplete */