obsidian-typings 2.35.0 → 2.36.0

package/dist/cjs/implementations.d.cts

@@ -5,7 +5,7 @@ import { ChangeDesc, Extension } from '@codemirror/state';
 import { EditorView, ViewUpdate } from '@codemirror/view';
 import { App as App$1, BrowserWindow } from 'electron';
 import moment$1 from 'moment';
-import { App, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, DataAdapter, Debouncer, EditableFileView, Editor, EditorPosition, EditorRange, EditorRangeOrCaret, EditorSuggest, EmbedCache, EventRef, Events, FileStats, FileView, FrontmatterLinkCache, HoverLinkSource, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, PaneType, Platform, Plugin as Plugin$1, PluginManifest, PluginSettingTab, Reference, ReferenceCache, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs } from 'obsidian';
+import { 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, Platform, Plugin as Plugin$1, PluginManifest, PluginSettingTab, Reference, ReferenceCache, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs } from 'obsidian';
 import { Application, Container, Graphics, Text as Text$1 } from 'pixi.js';
 
 /** @public */
@@ -2011,13 +2011,30 @@ export interface CodeMirrorEditorSearchCursor {
 	to(): EditorPosition | void;
 }
 /** @public */
+export interface CommandPaletteModal extends FuzzySuggestModal<Command> {
+	commands: Command[] | null;
+	plugin: CommandPalettePluginInstance;
+}
+/** @public */
+export interface CommandPaletteOptions {
+	pinned: string[];
+}
+/** @public */
 export interface CommandPalettePlugin extends InternalPlugin<CommandPalettePluginInstance> {
 }
 /** @public */
 export interface CommandPalettePluginInstance extends InternalPluginInstance<CommandPalettePlugin> {
 	app: App;
 	defaultOn: true;
+	modal: CommandPaletteModal;
+	options: CommandPaletteOptions;
 	plugin: CommandPalettePlugin;
+	recentCommands: string[];
+	getCommands(): Command[];
+	onExternalSettingsChange(): Promise<void>;
+	onOpen(): boolean;
+	openCallback(): boolean;
+	saveSettings(plugin: CommandPalettePlugin): void;
 }
 /** @public */
 export interface Commands {
@@ -5717,6 +5734,28 @@ export interface Submenu {
 	title: string;
 }
 /** @public */
+export interface SuggestModalChooser<T, TModal> {
+	chooser: TModal;
+	containerEl: HTMLDivElement;
+	numVisibleItems: number;
+	rowHeight: number;
+	selectedItem: number;
+	suggestions: HTMLDivElement[];
+	values: T[] | null;
+	addMessage(text: string | DocumentFragment): void;
+	addSuggestion(value: T): void;
+	forceSetSelectedItem(index: number, evt: MouseEvent | KeyboardEvent): void;
+	moveDown(evt: KeyboardEvent): false | void;
+	moveUp(evt: KeyboardEvent): false | void;
+	onSuggestionClick(evt: MouseEvent, suggestion: HTMLDivElement): void;
+	onSuggestionMouseover(evt: MouseEvent, suggestion: HTMLDivElement): void;
+	pageDown(evt: KeyboardEvent): false | void;
+	pageUp(evt: KeyboardEvent): false | void;
+	setSelectedItem(index: number, evt: MouseEvent | KeyboardEvent): void;
+	setSuggestions(values: T[]): void;
+	useSelectedItem(evt: MouseEvent | KeyboardEvent): void;
+}
+/** @public */
 export interface SuggestionContainer<T> {
 	/**
 	 * Which suggestions should be picked from

package/dist/cjs/types.d.cts

@@ -11,7 +11,7 @@ import * as fs from 'node:fs';
 import { Stats } from 'node:fs';
 import * as fsPromises from 'node:fs/promises';
 import * as path from 'node:path';
-import { App, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, Constructor, DataAdapter, Debouncer, EditableFileView, Editor, EditorPosition, EditorRange, EditorRangeOrCaret, EditorSuggest, EmbedCache, EventRef, Events, FileStats, FileView, FrontmatterLinkCache, HoverLinkSource, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, Notice as _Notice, ObsidianProtocolData, PaneType, Platform, Plugin as Plugin, PluginManifest, PluginSettingTab, Reference, ReferenceCache, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, request as _request, requestUrl as _requestUrl } from 'obsidian';
+import { 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, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, Notice as _Notice, ObsidianProtocolData, PaneType, Platform, Plugin as Plugin, PluginManifest, PluginSettingTab, Reference, ReferenceCache, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, request as _request, requestUrl as _requestUrl } from 'obsidian';
 import { Application, Container, Graphics, Text as Text$1 } from 'pixi.js';
 import _TurndownService from 'turndown';
 
@@ -573,9 +573,14 @@ declare module "obsidian" {
 declare module "obsidian" {
 	/** @todo Documentation incomplete */
 	interface SuggestModal<T> extends Modal, ISuggestOwner<T> {
+		chooser: SuggestModalChooser<T, this>;
 		/** @internal */
-		clearButtonEl: HTMLButtonElement;
+		clearButtonEl: HTMLDivElement;
 		ctaEl: HTMLDivElement;
+		instructionsEl: HTMLDivElement;
+		isOpen: boolean;
+		onInput(): void;
+		updateSuggestions(): void;
 	}
 }
 declare module "obsidian" {
@@ -2208,9 +2213,10 @@ declare module "obsidian" {
 		/** @internal Background applied to application to dim it */
 		bgEl: HTMLElement;
 		/** @internal Opacity percentage of the background */
-		bgOpacity: number;
+		bgOpacity: string;
 		/** @internal Whether the background is being dimmed */
 		dimBackground: boolean;
+		headerEl: HTMLDivElement;
 		/** @internal Modal container element */
 		modalEl: HTMLElement;
 		/** @internal Selection logic handler */
@@ -2396,7 +2402,7 @@ declare module "obsidian" {
 		/** @internal Scope that this scope is a child of */
 		parent: Scope | undefined;
 		/** @internal */
-		tabFocusContainer: HTMLElement | null;
+		tabFocusContainerEl: HTMLElement | null;
 		/**
 		 * @param event - Keyboard event
 		 * @param keypress - Pressed key information
@@ -5237,13 +5243,30 @@ export interface CodeMirrorEditorSearchCursor {
 	to(): EditorPosition | void;
 }
 /** @public */
+export interface CommandPaletteModal extends FuzzySuggestModal<Command> {
+	commands: Command[] | null;
+	plugin: CommandPalettePluginInstance;
+}
+/** @public */
+export interface CommandPaletteOptions {
+	pinned: string[];
+}
+/** @public */
 export interface CommandPalettePlugin extends InternalPlugin<CommandPalettePluginInstance> {
 }
 /** @public */
 export interface CommandPalettePluginInstance extends InternalPluginInstance<CommandPalettePlugin> {
 	app: App;
 	defaultOn: true;
+	modal: CommandPaletteModal;
+	options: CommandPaletteOptions;
 	plugin: CommandPalettePlugin;
+	recentCommands: string[];
+	getCommands(): Command[];
+	onExternalSettingsChange(): Promise<void>;
+	onOpen(): boolean;
+	openCallback(): boolean;
+	saveSettings(plugin: CommandPalettePlugin): void;
 }
 /** @public */
 export interface Commands {
@@ -8943,6 +8966,28 @@ export interface Submenu {
 	title: string;
 }
 /** @public */
+export interface SuggestModalChooser<T, TModal> {
+	chooser: TModal;
+	containerEl: HTMLDivElement;
+	numVisibleItems: number;
+	rowHeight: number;
+	selectedItem: number;
+	suggestions: HTMLDivElement[];
+	values: T[] | null;
+	addMessage(text: string | DocumentFragment): void;
+	addSuggestion(value: T): void;
+	forceSetSelectedItem(index: number, evt: MouseEvent | KeyboardEvent): void;
+	moveDown(evt: KeyboardEvent): false | void;
+	moveUp(evt: KeyboardEvent): false | void;
+	onSuggestionClick(evt: MouseEvent, suggestion: HTMLDivElement): void;
+	onSuggestionMouseover(evt: MouseEvent, suggestion: HTMLDivElement): void;
+	pageDown(evt: KeyboardEvent): false | void;
+	pageUp(evt: KeyboardEvent): false | void;
+	setSelectedItem(index: number, evt: MouseEvent | KeyboardEvent): void;
+	setSuggestions(values: T[]): void;
+	useSelectedItem(evt: MouseEvent | KeyboardEvent): void;
+}
+/** @public */
 export interface SuggestionContainer<T> {
 	/**
 	 * Which suggestions should be picked from