obsidian-typings 4.80.0 → 4.82.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, 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, 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 { 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,14 +614,28 @@ 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: HoverPopover | null;
+	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.
@@ -1357,6 +1371,78 @@ 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
  *
@@ -3808,6 +3894,18 @@ 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.
@@ -6055,6 +6153,18 @@ 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.
@@ -6281,6 +6391,18 @@ 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.
@@ -9039,13 +9161,25 @@ export interface MultiselectOptionContextMenuContext {
  */
 export interface MultitextPropertyWidgetComponent extends PropertyWidgetComponentBase {
 	/** The hover popover for the property widget. */
-	hoverPopover: HoverPopover | null;
+	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.
@@ -9161,6 +9295,18 @@ 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.
@@ -9850,6 +9996,18 @@ 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}.
@@ -10049,8 +10207,6 @@ 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;
 	/**
@@ -10059,18 +10215,6 @@ 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.
@@ -11361,6 +11505,18 @@ 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.
@@ -11389,46 +11545,34 @@ 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 link element for the property widget. */
-	linkEl: HTMLDivElement;
-	/** The link text element for the property widget. */
-	linkTextEl: HTMLDivElement;
+	/** The hover popover for the property widget. */
+	hoverPopover: null;
 	/** The type of the property widget. */
 	type: "text";
 	/** The value of the property widget. */
 	value: string;
 	/**
-	 * Get the display text of the link from the property widget.
-	 *
-	 * @returns The display text.
-	 */
-	getDisplayText(): string;
-	/**
-	 * Get the link text of the property widget.
-	 *
-	 * @returns The link text.
+	 * Render the property widget.
 	 */
-	getLinkText(): string;
+	render(): void;
 	/**
-	 * Check if the property widget link has an alias.
+	 * Handle focus event.
 	 *
-	 * @returns Whether the property widget link has an alias.
+	 * @param mode - The focus mode.
 	 */
-	isAlias(): boolean;
+	onFocus(): void;
 	/**
-	 * Check if the property widget link is a wikilink.
+	 * Set the value of the property widget.
 	 *
-	 * @returns Whether the property widget link is a wikilink.
-	 */
-	isWikilink(): boolean;
-	/**
-	 * Render the property widget.
+	 * @param value - The value to set.
 	 */
-	render(): void;
+	setValue(value: unknown): void;
 }
 /**
  * @todo Documentation incomplete.