obsidian-typings 4.84.0 → 4.85.0

package/dist/cjs/implementations.d.cts

@@ -8,7 +8,7 @@ import type { Tree as LezerTree } from '@lezer/common';
 import type { App as App$1, BrowserWindow } from 'electron';
 import type { Mermaid } from 'mermaid';
 import type { FSWatcher } from 'node:fs';
-import type { App, BasesConfigFileFilter, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, DataAdapter, Debouncer, EditableFileView, Editor, EditorPosition, EditorRange, EditorRangeOrCaret, EditorSuggest, EmbedCache, EventRef, Events, FileStats, FileView, FrontmatterLinkCache, FuzzySuggestModal, HoverLinkSource, HoverParent, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, PaneType, Plugin as Plugin, PluginManifest, PluginSettingTab, PopoverSuggest, Reference, ReferenceCache, RenderContext, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, moment as moment$1 } from 'obsidian';
+import type { App, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, DataAdapter, Debouncer, EditableFileView, Editor, EditorPosition, EditorRange, EditorRangeOrCaret, EditorSuggest, EmbedCache, EventRef, Events, FileStats, FileView, FrontmatterLinkCache, FuzzySuggestModal, HoverLinkSource, HoverParent, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, PaneType, Plugin as Plugin, PluginManifest, PluginSettingTab, PopoverSuggest, Reference, ReferenceCache, RenderContext, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, moment as moment$1 } from 'obsidian';
 import type { default as pdfjsLib } from 'pdfjs-dist';
 import type { Application, Container, Graphics, ICanvas, Sprite, Text as Text$1, TextStyle } from 'pixi.js';
 import type { default as Prism$1 } from 'prismjs';
@@ -614,28 +614,14 @@ export interface AddOverlayOptions {
  * @unofficial
  */
 export interface AliasesPropertyWidgetComponent extends PropertyWidgetComponentBase {
-	/** The container element for the property widget. */
-	containerEl: HTMLElement;
 	/** The render context for the property widget. */
 	ctx: PropertyRenderContext;
 	/** The hover popover for the property widget. */
-	hoverPopover: null;
+	hoverPopover: HoverPopover | null;
 	/** The multiselect component for the property widget. */
 	multiselect: Multiselect;
 	/** The type of the property widget. */
 	type: "aliases";
-	/**
-	 * Handle focus event.
-	 *
-	 * @param mode - The focus mode.
-	 */
-	onFocus(): void;
-	/**
-	 * Set the value of the property widget.
-	 *
-	 * @param value - The value to set.
-	 */
-	setValue(value: unknown): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -1371,78 +1357,6 @@ export interface BacklinkView extends InfoFileView {
  */
 export interface BacklinkViewConstructor extends TypedViewConstructor<BacklinkView> {
 }
-/**
- * BasesConfigFileFilter `and` clause.
- *
- * @public
- * @unofficial
- */
-export interface BasesConfigFileFilterAndClause {
-	/**
-	 * All of the following filters must match.
-	 *
-	 * @public
-	 * @since 1.10.0
-	 * @example
-	 * ```ts
-	 * {
-	 *     and: [
-	 *         '*.md',
-	 *         '*.txt',
-	 *     ],
-	 * }
-	 * ```
-	 */
-	and: BasesConfigFileFilter[];
-}
-/**
- * BasesConfigFileFilter `not` clause.
- *
- * @public
- * @unofficial
- */
-export interface BasesConfigFileFilterNotClause {
-	/**
-	 * None of the following filters should match.
-	 *
-	 * @public
-	 * @since 1.10.0
-	 * @example
-	 * ```ts
-	 * {
-	 *     not: [
-	 *         '*.md',
-	 *         '*.txt',
-	 *     ],
-	 * }
-	 * ```
-	 */
-	not: BasesConfigFileFilter[];
-}
-/**
- * BasesConfigFileFilter `or` clause.
- *
- * @public
- * @unofficial
- */
-export interface BasesConfigFileFilterOrClause {
-	/**
-	 * Some of the following filters should match.
-	 *
-	 * @public
-	 * @since 1.10.0
-	 * @example
-	 * ```ts
-	 * {
-	 *     or: [
-	 *         '*.md',
-	 *         '*.txt',
-	 *     ],
-	 * }
-	 * ```
-	 */
-	or: BasesConfigFileFilter[];
-}
 /**
  * Bases context
  *
@@ -3894,18 +3808,6 @@ export interface CheckboxPropertyWidgetComponent extends PropertyWidgetComponent
 	checkboxEl: HTMLInputElement;
 	/** The type of the property widget. */
 	type: "checkbox";
-	/**
-	 * Handle focus event.
-	 *
-	 * @param mode - The focus mode.
-	 */
-	onFocus(): void;
-	/**
-	 * Set the value of the property widget.
-	 *
-	 * @param value - The value to set.
-	 */
-	setValue(value: unknown): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -4882,6 +4784,97 @@ export interface Dimensions {
 	/** @todo Documentation incomplete. */
 	width: number;
 }
+/**
+ * The handlers for the DOM events.
+ *
+ * @public
+ * @unofficial
+ */
+export interface DomEventsHandlers {
+	/**
+	 * Handles the external link click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onExternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the external link right click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onExternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the internal link click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onInternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the internal link drag event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 * @param title - The title.
+	 */
+	onInternalLinkDrag(evt: MouseEvent, targetEl: HTMLElement, linkText: string, title?: string): unknown;
+	/**
+	 * Handles the internal link mouseover event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onInternalLinkMouseover(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the internal link right click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onInternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the tag click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onTagClick(evt: MouseEvent, targetEl: HTMLElement, tag: string): unknown;
+}
+/**
+ * The DomEventsHandlers constructor.
+ *
+ * @public
+ * @unofficial
+ */
+export interface DomEventsHandlersConstructor extends ConstructorBase<[
+	info: DomEventsHandlersInfo
+], DomEventsHandlers> {
+}
+/**
+ * Information about the DOM events handlers.
+ *
+ * @public
+ * @unofficial
+ */
+export interface DomEventsHandlersInfo extends HoverParent {
+	/**
+	 * Obsidian app instance.
+	 */
+	app: App;
+	/**
+	 * The path to calculate relative links from.
+	 */
+	path: string;
+}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -6153,18 +6146,6 @@ export interface FilePropertyWidgetComponent extends PropertyWidgetComponentBase
 	inputEl: HTMLInputElement;
 	/** The type of the property widget. */
 	type: "file";
-	/**
-	 * Handle focus event.
-	 *
-	 * @param mode - The focus mode.
-	 */
-	onFocus(): void;
-	/**
-	 * Set the value of the property widget.
-	 *
-	 * @param value - The value to set.
-	 */
-	setValue(value: unknown): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -6391,18 +6372,6 @@ export interface FolderPropertyWidgetComponent extends PropertyWidgetComponentBa
 	inputEl: HTMLInputElement;
 	/** The type of the property widget. */
 	type: "folder";
-	/**
-	 * Handle focus event.
-	 *
-	 * @param mode - The focus mode.
-	 */
-	onFocus(): void;
-	/**
-	 * Set the value of the property widget.
-	 *
-	 * @param value - The value to set.
-	 */
-	setValue(value: unknown): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -9176,25 +9145,13 @@ export interface MultiselectOptionContextMenuContext {
  */
 export interface MultitextPropertyWidgetComponent extends PropertyWidgetComponentBase {
 	/** The hover popover for the property widget. */
-	hoverPopover: null;
+	hoverPopover: HoverPopover | null;
 	/** The multiselect component for the property widget. */
 	multiselect: Multiselect;
 	/** The type of the property widget. */
 	type: "multitext";
 	/** The values of the property widget. */
 	valueSet: Set<string>;
-	/**
-	 * Handle focus event.
-	 *
-	 * @param mode - The focus mode.
-	 */
-	onFocus(): void;
-	/**
-	 * Set the value of the property widget.
-	 *
-	 * @param value - The value to set.
-	 */
-	setValue(value: unknown): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -9310,18 +9267,6 @@ export interface NumberPropertyWidgetComponent extends PropertyWidgetComponentBa
 	type: "number";
 	/** Show the error message. */
 	showError(): void;
-	/**
-	 * Handle focus event.
-	 *
-	 * @param mode - The focus mode.
-	 */
-	onFocus(): void;
-	/**
-	 * Set the value of the property widget.
-	 *
-	 * @param value - The value to set.
-	 */
-	setValue(value: unknown): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -10011,18 +9956,6 @@ export interface PropertyPropertyWidgetComponent extends PropertyWidgetComponent
 	inputEl: HTMLInputElement;
 	/** The type of the property widget. */
 	type: "property";
-	/**
-	 * Handle focus event.
-	 *
-	 * @param mode - The focus mode.
-	 */
-	onFocus(): void;
-	/**
-	 * Set the value of the property widget.
-	 *
-	 * @param value - The value to set.
-	 */
-	setValue(value: unknown): void;
 }
 /**
  * Combobox component for {@link PropertyPropertyWidgetComponent}.
@@ -10222,6 +10155,8 @@ export interface PropertyWidget<ComponentType extends PropertyWidgetComponentBas
  * @unofficial
  */
 export interface PropertyWidgetComponentBase {
+	/** The container element for the property widget. */
+	containerEl: HTMLElement;
 	/** The type of the property widget. */
 	type: string;
 	/**
@@ -10230,6 +10165,18 @@ export interface PropertyWidgetComponentBase {
 	 * @param mode - The focus mode.
 	 */
 	focus(mode?: FocusMode): void;
+	/**
+	 * Handle focus event.
+	 *
+	 * @param mode - The focus mode.
+	 */
+	onFocus(mode: FocusMode): void;
+	/**
+	 * Set the value of the property widget.
+	 *
+	 * @param value - The value to set.
+	 */
+	setValue(value: unknown): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -10385,97 +10332,6 @@ export interface RecentFileTracker {
 	 */
 	serialize(): string[];
 }
-/**
- * The handlers for the DOM events.
- *
- * @public
- * @unofficial
- */
-export interface RegisterDomEventsHandlers {
-	/**
-	 * Handles the external link click event.
-	 *
-	 * @param evt - The mouse event.
-	 * @param targetEl - The target element.
-	 * @param linkText - The link text.
-	 */
-	onExternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
-	/**
-	 * Handles the external link right click event.
-	 *
-	 * @param evt - The mouse event.
-	 * @param targetEl - The target element.
-	 * @param linkText - The link text.
-	 */
-	onExternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
-	/**
-	 * Handles the internal link click event.
-	 *
-	 * @param evt - The mouse event.
-	 * @param targetEl - The target element.
-	 * @param linkText - The link text.
-	 */
-	onInternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
-	/**
-	 * Handles the internal link drag event.
-	 *
-	 * @param evt - The mouse event.
-	 * @param targetEl - The target element.
-	 * @param linkText - The link text.
-	 * @param title - The title.
-	 */
-	onInternalLinkDrag(evt: MouseEvent, targetEl: HTMLElement, linkText: string, title?: string): unknown;
-	/**
-	 * Handles the internal link mouseover event.
-	 *
-	 * @param evt - The mouse event.
-	 * @param targetEl - The target element.
-	 * @param linkText - The link text.
-	 */
-	onInternalLinkMouseover(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
-	/**
-	 * Handles the internal link right click event.
-	 *
-	 * @param evt - The mouse event.
-	 * @param targetEl - The target element.
-	 * @param linkText - The link text.
-	 */
-	onInternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
-	/**
-	 * Handles the tag click event.
-	 *
-	 * @param evt - The mouse event.
-	 * @param targetEl - The target element.
-	 * @param linkText - The link text.
-	 */
-	onTagClick(evt: MouseEvent, targetEl: HTMLElement, tag: string): unknown;
-}
-/**
- * The RegisterDomEventsHandlers constructor.
- *
- * @public
- * @unofficial
- */
-export interface RegisterDomEventsHandlersConstructor extends ConstructorBase<[
-	info: RegisterDomEventsHandlersInfo
-], RegisterDomEventsHandlers> {
-}
-/**
- * Information about the register dom events handlers.
- *
- * @public
- * @unofficial
- */
-export interface RegisterDomEventsHandlersInfo extends HoverParent {
-	/**
-	 * Obsidian app instance.
-	 */
-	app: App;
-	/**
-	 * The path to calculate relative links from.
-	 */
-	path: string;
-}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -11611,18 +11467,6 @@ export interface TagsPropertyWidgetComponent extends PropertyWidgetComponentBase
 	multiselect: Multiselect;
 	/** The type of the property widget. */
 	type: "tags";
-	/**
-	 * Handle focus event.
-	 *
-	 * @param mode - The focus mode.
-	 */
-	onFocus(): void;
-	/**
-	 * Set the value of the property widget.
-	 *
-	 * @param value - The value to set.
-	 */
-	setValue(value: unknown): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -11651,34 +11495,46 @@ export interface TemplatesPluginInstance extends InternalPluginInstance<Template
  * @unofficial
  */
 export interface TextPropertyWidgetComponent extends PropertyWidgetComponentBase {
-	/** The container element for the property widget. */
-	containerEl: HTMLElement;
 	/** The render context for the property widget. */
 	ctx: PropertyRenderContext;
 	/** The input element for the property widget. */
 	inputEl: HTMLInputElement;
-	/** The hover popover for the property widget. */
-	hoverPopover: null;
+	/** The link element for the property widget. */
+	linkEl: HTMLDivElement;
+	/** The link text element for the property widget. */
+	linkTextEl: HTMLDivElement;
 	/** The type of the property widget. */
 	type: "text";
 	/** The value of the property widget. */
 	value: string;
 	/**
-	 * Render the property widget.
+	 * Get the display text of the link from the property widget.
+	 *
+	 * @returns The display text.
 	 */
-	render(): void;
+	getDisplayText(): string;
 	/**
-	 * Handle focus event.
+	 * Get the link text of the property widget.
 	 *
-	 * @param mode - The focus mode.
+	 * @returns The link text.
 	 */
-	onFocus(): void;
+	getLinkText(): string;
 	/**
-	 * Set the value of the property widget.
+	 * Check if the property widget link has an alias.
 	 *
-	 * @param value - The value to set.
+	 * @returns Whether the property widget link has an alias.
 	 */
-	setValue(value: unknown): void;
+	isAlias(): boolean;
+	/**
+	 * Check if the property widget link is a wikilink.
+	 *
+	 * @returns Whether the property widget link is a wikilink.
+	 */
+	isWikilink(): boolean;
+	/**
+	 * Render the property widget.
+	 */
+	render(): void;
 }
 /**
  * @todo Documentation incomplete.