obsidian-typings 4.81.0 → 4.83.0

package/README.md

@@ -95,6 +95,12 @@ In most cases, we recommend to always use the latest release.
 >
 > If you run `npm install obsidian-typings` instead, the most likely, the library will not get updated.
 
+> [!WARNING]
+>
+> The package installs several libraries that trigger `npm audit` warnings.
+>
+> Those packages cannot be updated because they should match the exact versions Obsidian uses internally.
+
 ### 2. Enable in `tsconfig.json` (recommended) <span id="add-types-setting-to-tsconfig-json"></span>
 
 Add `obsidian-typings` to the `types` array of your `tsconfig.json` to make all extended typings available globally without explicit importing them:

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, 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';
@@ -1357,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
  *
@@ -7304,24 +7232,39 @@ export interface HotkeysSettingTab extends SettingTab {
 export interface HourFunction extends BasesFunction, HasExtract {
 }
 /**
- * @todo Documentation incomplete.
+ * Event triggered when a link is hovered.
+ *
  * @public
  * @unofficial
  */
 export interface HoverLinkEvent {
-	/** @todo Documentation incomplete. */
+	/**
+	 * The mouse event.
+	 */
 	event: MouseEvent;
-	/** @todo Documentation incomplete. */
-	hoverParent: WorkspaceLeaf;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The hover parent.
+	 */
+	hoverParent: HoverParent;
+	/**
+	 * The link text.
+	 */
 	linktext: string;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The source of the event.
+	 */
 	source: "search" | "editor" | "preview" | "properties" | "graph" | "file-explorer" | "hover-link";
-	/** @todo Documentation incomplete. */
+	/**
+	 * The source path.
+	 */
 	sourcePath?: string;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The state of the event.
+	 */
 	state?: HoverLinkEventState;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The target element.
+	 */
 	targetEl: HTMLElement | null;
 }
 /**
@@ -10298,6 +10241,97 @@ 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

package/dist/cjs/types.d.cts

@@ -16,7 +16,7 @@ import * as fs from 'node:fs';
 import type { FSWatcher, Stats } from 'node:fs';
 import * as fsPromises from 'node:fs/promises';
 import * as path from 'node:path';
-import type { App, BasesConfigFileFilter, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, Constructor, DataAdapter, Debouncer, EditableFileView, Editor, EditorPosition, EditorRange, EditorRangeOrCaret, EditorSuggest, EmbedCache, EventRef, Events, FileStats, FileView, FrontmatterLinkCache, FuzzySuggestModal, HoverLinkSource, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, Notice, ObsidianProtocolHandler, 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, request, requestUrl } from 'obsidian';
+import type { App, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, Constructor, 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, Notice, ObsidianProtocolHandler, 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, request, requestUrl } from 'obsidian';
 import type { default as pdfjsLib } from 'pdfjs-dist';
 import type { Application, Container, Graphics, ICanvas, Sprite, Text as Text$1, TextStyle, default as PIXI } from 'pixi.js';
 import type { default as Prism$1 } from 'prismjs';
@@ -2323,7 +2323,7 @@ declare module "obsidian" {
 	 *
 	 * @deprecated - Added only for typing purposes. Use {@link BasesConfigFileFilter} instead.
 	 */
-	type BasesConfigFileFilter__ = string | BasesConfigFileFilterAndClause | BasesConfigFileFilterOrClause | BasesConfigFileFilterNotClause;
+	type BasesConfigFileFilter__ = string | {} | {} | {};
 }
 declare module "obsidian" {
 	/**
@@ -5481,18 +5481,11 @@ declare module "obsidian" {
 		 */
 		app: App;
 		/**
-		 * HTML element for the setting tab content.
+		 * Outermost HTML element on the setting tab.
 		 *
 		 * @official
 		 */
 		containerEl: HTMLElement;
-		/**
-		 * The icon to display in the settings sidebar.
-		 *
-		 * @official
-		 * @since 1.11.0
-		 */
-		icon: IconName;
 		/**
 		 * Unique ID of the tab.
 		 *
@@ -5627,20 +5620,6 @@ declare module "obsidian" {
 		 * @official
 		 */
 		addColorPicker(cb: (component: ColorComponent) => any): this;
-		/**
-		 * Add a component to the setting.
-		 *
-		 * @param cb - The callback to add the component.
-		 * @returns The setting.
-		 * @example
-		 * ```ts
-		 * setting.addComponent((el) => {
-		 *     return new TextComponent(el);
-		 * });
-		 * @official
-		 * @since 1.11.0
-		 */
-		addComponent<T extends BaseComponent>(cb: (el: HTMLElement) => T): this;
 		/**
 		 * Add a dropdown component to the setting.
 		 *
@@ -10295,14 +10274,6 @@ declare module "obsidian" {
 		tags?: TagCache[];
 	}
 }
-declare module "obsidian" {
-	/**
-	 * Can be any Lucide icon name or an internal icon name.
-	 *
-	 * @deprecated - Added only for typing purposes. Use {@link IconName} instead.
-	 */
-	type IconName__ = string;
-}
 declare module "obsidian" {
 	/**
 	 * Collapsible container for other ViewOptions.
@@ -13508,66 +13479,6 @@ declare module "obsidian" {
 		top: number;
 	}
 }
-declare module "obsidian" {
-	/**
-	 * Setting group.
-	 *
-	 * @since 1.11.0
-	 */
-	interface SettingGroup {
-		/**
-		 * Add a CSS class to the setting group.
-		 *
-		 * @param cls - The CSS class to add.
-		 * @returns The setting group.
-		 * @example
-		 * ```ts
-		 * settingGroup.addClass('foo');
-		 * ```
-		 * @official
-		 * @since 1.11.0
-		 */
-		addClass(cls: string): this;
-		/**
-		 * Add a setting to the setting group.
-		 *
-		 * @param cb - The callback to add the setting.
-		 * @returns The setting group.
-		 * @example
-		 * ```ts
-		 * settingGroup.addSetting((setting) => {
-		 *     setting.setName('foo');
-		 * });
-		 * ```
-		 * @official
-		 * @since 1.11.0
-		 */
-		addSetting(cb: (setting: Setting) => void): this;
-		/**
-		 * Create a new setting group.
-		 *
-		 * @param containerEl - The container element.
-		 * @returns The setting group.
-		 * @official
-		 * @since 1.11.0
-		 * @deprecated - Added only for typing purposes. Use {@link constructor} instead.
-		 */
-		constructor__(containerEl: HTMLElement): this;
-		/**
-		 * Set the heading of the setting group.
-		 *
-		 * @param text - The text to set the heading to.
-		 * @returns The setting group.
-		 * @example
-		 * ```ts
-		 * settingGroup.setHeading('foo');
-		 * ```
-		 * @official
-		 * @since 1.11.0
-		 */
-		setHeading(text: string | DocumentFragment): this;
-	}
-}
 declare module "obsidian" {
 	/**
 	 * Slider option.
@@ -15242,6 +15153,14 @@ declare module "obsidian" {
 	 */
 	type EditorCommandName__ = "goUp" | "goDown" | "goLeft" | "goRight" | "goStart" | "goEnd" | "goWordLeft" | "goWordRight" | "indentMore" | "indentLess" | "newlineAndIndent" | "swapLineUp" | "swapLineDown" | "deleteLine" | "toggleFold" | "foldAll" | "unfoldAll";
 }
+declare module "obsidian" {
+	/**
+	 * The name of the icon.
+	 *
+	 * @deprecated - Added only for typing purposes. Use {@link IconName} instead.
+	 */
+	type IconName__ = string;
+}
 declare module "obsidian" {
 	/**
 	 * The object stored in the view plugin {@link livePreviewState}
@@ -15381,6 +15300,16 @@ declare module "obsidian" {
 		 * @since 0.12.11
 		 */
 		function createCodeBlockPostProcessor__(language: string, handler: (source: string, el: HTMLElement, ctx: MarkdownPostProcessorContext) => Promise<any> | void): (el: HTMLElement, ctx: MarkdownPostProcessorContext) => void;
+		/**
+		 * Registers the DOM events.
+		 *
+		 * @param el - The element to register the events on.
+		 * @param handlers - The handlers to register.
+		 * @param childElFn - The function to determine if `childEl` belongs to the `el`.
+		 *
+		 * @unofficial
+		 */
+		function registerDomEvents(el: HTMLElement, handlers: RegisterDomEventsHandlers, childElFn?: (childEl: HTMLElement) => boolean): void;
 		/**
 		 * Register a post processor.
 		 *
@@ -19768,78 +19697,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
  *
@@ -25715,24 +25572,39 @@ export interface HotkeysSettingTab extends SettingTab {
 export interface HourFunction extends BasesFunction, HasExtract {
 }
 /**
- * @todo Documentation incomplete.
+ * Event triggered when a link is hovered.
+ *
  * @public
  * @unofficial
  */
 export interface HoverLinkEvent {
-	/** @todo Documentation incomplete. */
+	/**
+	 * The mouse event.
+	 */
 	event: MouseEvent;
-	/** @todo Documentation incomplete. */
-	hoverParent: WorkspaceLeaf;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The hover parent.
+	 */
+	hoverParent: HoverParent;
+	/**
+	 * The link text.
+	 */
 	linktext: string;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The source of the event.
+	 */
 	source: "search" | "editor" | "preview" | "properties" | "graph" | "file-explorer" | "hover-link";
-	/** @todo Documentation incomplete. */
+	/**
+	 * The source path.
+	 */
 	sourcePath?: string;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The state of the event.
+	 */
 	state?: HoverLinkEventState;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The target element.
+	 */
 	targetEl: HTMLElement | null;
 }
 /**
@@ -28709,6 +28581,97 @@ 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