obsidian-typings 1.1.3 → 1.1.5

package/obsidian-ex.d.ts

@@ -5,6 +5,7 @@ import * as fs from "fs";
 import * as fsPromises from "fs/promises";
 import {
 	CachedMetadata,
+	CacheItem,
 	Command,
 	Component,
 	EditorPosition,
@@ -28,6 +29,12 @@ import {
 import * as path from "path";
 export * from "obsidian";
 
+declare global {
+	interface DomElementInfo {
+		[eventName: `on${string}`]: EventListenerOrEventListenerObject;
+	}
+}
+
 declare module "@codemirror/view" {
 	/** @todo Documentation incomplete */
 	interface EditorView {
@@ -116,6 +123,7 @@ declare module "obsidian" {
 		| "showLineNumber"
 		| "showUnsupportedFiles"
 		| "showViewHeader"
+		| "showRibbon"
 		| "smartIndentList"
 		| "spellcheck"
 		| "spellcheckLanguages"
@@ -183,7 +191,13 @@ declare module "obsidian" {
 	/** @todo Documentation incomplete */
 	type TreeItem<T> = TreeNode<T> & {
 		collapseEl: HTMLElement;
+		/**
+		 * @deprecated Potentially removed in 1.6.0 for some tree-likes
+		 */
 		collapsed: boolean;
+		/**
+		 * @deprecated Potentially removed in 1.6.0 for some tree-likes
+		 */
 		collapsible: boolean;
 		coverEl: HTMLElement;
 		innerEl: HTMLElement;
@@ -323,8 +337,10 @@ declare module "obsidian" {
 	interface App {
 		/**
 		 * The account signed in to Obsidian
+		 *
+		 * @deprecated Property is now undefined, removed pre-1.6.0
 		 */
-		account: Account;
+		account: Account | undefined;
 		/**
 		 * ID that uniquely identifies the vault
 		 *
@@ -379,11 +395,12 @@ declare module "obsidian" {
 		/**
 		 * Whether the application is currently running on mobile
 		 *
+		 * @deprecated Will be inaccessible in a future version, prefer using `Platform.isMobile`
 		 * @remark Prefer usage of `Platform.isMobile`
 		 * @remark Will be true if `app.emulateMobile()` was enabled
 		 */
 		isMobile: boolean;
-		/** @internal */
+		/** @deprecated Made inaccessible in 1.6.0, this object can be recreated using Notices */
 		loadProgress: LoadProgress;
 		/**
 		 * Manages the gathering and updating of metadata for all files in the vault
@@ -782,6 +799,10 @@ declare module "obsidian" {
 		 * Editor > Show line numbers
 		 */
 		showLineNumber?: false | boolean;
+		/**
+		 * Appearance > Show ribbon
+		 */
+		showRibbon?: true | boolean;
 		/**
 		 * Files & Links > Detect all file extensions
 		 */
@@ -851,14 +872,14 @@ declare module "obsidian" {
 		vimMode?: false | boolean;
 	}
 
-    /**
-     * @remark `BaseEditor` is never used in the Obsidian codebase, but is exposed in the Obsidian module as `Editor`.
-     *       However, most editor components actually make use of the extended `Editor`, so this interface is purposely
-     *       named to `BaseEditor` to not require any casting for most purposes (or overriding the `editor` property type
-     *       for all components).
-     * @todo Potential risk of confusion when `Editor` is constructed from the Obsidian module, as it only has the 
-     *       methods from `BaseEditor`, *not* `Editor`
-     */
+	/**
+	 * @remark `BaseEditor` is never used in the Obsidian codebase, but is exposed in the Obsidian module as `Editor`.
+	 *       However, most editor components actually make use of the extended `Editor`, so this interface is purposely
+	 *       named to `BaseEditor` to not require any casting for most purposes (or overriding the `editor` property type
+	 *       for all components).
+	 * @todo Potential risk of confusion when `Editor` is constructed from the Obsidian module, as it only has the
+	 *       methods from `BaseEditor`, *not* `Editor`
+	 */
 	interface BaseEditor {
 		/**
 		 * CodeMirror editor instance
@@ -955,6 +976,10 @@ declare module "obsidian" {
 		cache: unknown;
 	}
 
+	interface CachedMetadata {
+		footnotes?: FootnoteCache[];
+	}
+
 	interface CanvasConnection {}
 
 	interface CanvasLeaf extends WorkspaceLeaf {}
@@ -1865,6 +1890,10 @@ declare module "obsidian" {
 
 	/** @todo Documentation incomplete */
 	interface FileExplorerPlugin extends InternalPlugin {
+		/** @internal */
+		attachDropHandler(x: unknown, y: unknown, z: unknown): unknown;
+		/** @internal Get a sorted list of the tree items for a specific folder) */
+		getSortedFolderItems(folder: TFolder): FileTreeItem[];
 		/**
 		 * Reveals a file or folder in the file explorer view, opens the view if it is not already
 		 * open/visible
@@ -2092,6 +2121,8 @@ declare module "obsidian" {
 		 * 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" }];
 		/**
 		 * Get suggestions for current input text
 		 *
@@ -2136,6 +2167,13 @@ declare module "obsidian" {
 	interface FoldManager {
 	}
 
+	/**
+	 * Cache item containing a notes footnotes metadata
+	 */
+	interface FootnoteCache extends CacheItem {
+		identifier: string;
+	}
+
 	/** @todo Documentation incomplete */
 	interface GlobalSearchLeaf extends WorkspaceLeaf {}
 
@@ -2189,6 +2227,10 @@ declare module "obsidian" {
 		getHotkeys(command: string): KeymapInfo[];
 		/** @internal Load hotkeys from storage */
 		load(): void;
+		/** @internal */
+		onConfigFileChanged(): void;
+		/** @internal */
+		onRaw(e: unknown): void;
 		/**
 		 * Trigger a command by keyboard event
 		 *
@@ -2202,6 +2244,8 @@ declare module "obsidian" {
 		 * @param command
 		 */
 		printHotkeyForCommand(command: string): string;
+		/** @internal */
+		registerListeners(): void;
 		/**
 		 * Remove a hotkey from the default hotkeys
 		 *
@@ -2244,6 +2288,12 @@ declare module "obsidian" {
 		display: string;
 	}
 
+	/** @todo Documentation incomplete */
+	interface HoverPopover {
+		/** @internal */
+		watchResize(): void;
+	}
+
 	class IFramedMarkdownEditor extends MarkdownScrollableEditView {
 		constructor(context: WidgetEditorView);
 		/**
@@ -2317,10 +2367,16 @@ declare module "obsidian" {
 
 	/** @todo Documentation incomplete */
 	interface InternalPlugin extends Plugin {
+		instance: InternalPluginInstance<this>;
+
 		disable(): void;
 		enable(): void;
 	}
 
+	interface InternalPluginInstance<TPlugin> {
+		plugin: TPlugin;
+	}
+
 	interface InternalPlugins extends Events {
 		/**
 		 * Reference to App
@@ -2350,9 +2406,9 @@ declare module "obsidian" {
 		 *
 		 * @param id - ID of the plugin to get
 		 */
-		getEnabledPluginById(id: InternalPluginName): InternalPlugin | null;
-		getEnabledPluginById(id: "file-explorer"): FileExplorerPlugin | null;
-		getEnabledPluginById(id: "global-search"): GlobalSearchPlugin | null;
+		getEnabledPluginById(id: InternalPluginName): InternalPluginInstance<InternalPlugin> | null;
+		getEnabledPluginById(id: "file-explorer"): InternalPluginInstance<FileExplorerPlugin> | null;
+		getEnabledPluginById(id: "global-search"): InternalPluginInstance<GlobalSearchPlugin> | null;
 		/**
 		 * Get all enabled internal plugins
 		 */
@@ -2979,6 +3035,7 @@ declare module "obsidian" {
 		/**
 		 * Add property to inline metadata editor or properties plugin
 		 *
+		 * @deprecated Removed in 1.6.0
 		 * @remark Parameter is not used
 		 */
 		addProperty(unused: undefined): void;
@@ -3012,6 +3069,8 @@ declare module "obsidian" {
 		 * 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
 		 */
@@ -3398,7 +3457,7 @@ declare module "obsidian" {
 		/**
 		 * Get an entry from the file cache
 		 */
-		getFileInfo(path: string): FileCacheEntry;
+		getFileInfo(path: string): FileCacheEntry | undefined;
 		/**
 		 * Get property values for frontmatter property key
 		 */
@@ -3776,6 +3835,10 @@ declare module "obsidian" {
 		getTypes(): string[];
 		/** @internal Load property types from config */
 		loadData(): Promise<void>;
+		/** @internal */
+		onRaw(e: unknown): void;
+		/** @internal */
+		registerListeners(): void;
 		/** @internal Save property types to config */
 		save(): Promise<void>;
 		/** @internal Get all properties from metadata cache */
@@ -4530,6 +4593,12 @@ declare module "obsidian" {
 		useSelectedItem(event: Event): boolean;
 	}
 
+	/** @todo Documentation incomplete */
+	interface SuggestModal<T> {
+		/** @internal */
+		clearButtonEl: HTMLButtonElement;
+	}
+
 	/** @todo Documentation incomplete */
 	interface TableCell {
 		col: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "obsidian-typings",
-    "version": "1.1.3",
+    "version": "1.1.5",
     "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
     "main": "",
     "types": "obsidian-ex.d.ts",
@@ -31,6 +31,9 @@
     },
     "scripts": {
         "build": "tsc --build --force",
-        "format": "bun run sort-interfaces.ts obsidian-ex.d.ts && bun dprint fmt obsidian-ex.d.ts"
+        "format": "bun run scripts/sort-interfaces.ts obsidian-ex.d.ts && bun dprint fmt obsidian-ex.d.ts",
+        "release-patch": "bun run scripts/bump-version.ts patch",
+        "release-minor": "bun run scripts/bump-version.ts minor",
+        "release-major": "bun run scripts/bump-version.ts major"
     }
-}
+}