obsidian-typings 1.1.2 → 1.1.4

package/obsidian-ex.d.ts

@@ -4,30 +4,36 @@ import { IpcRenderer } from "electron";
 import * as fs from "fs";
 import * as fsPromises from "fs/promises";
 import {
-	CachedMetadata,
-	Command,
-	Component,
-	EditorPosition,
-	EditorRange,
-	EditorRangeOrCaret,
-	EditorSuggest,
-	Events,
-	HoverPopover,
-	KeymapInfo,
-	Loc,
-	MarkdownFileInfo,
-	MarkdownSubView,
-	MarkdownViewModeType,
-	Plugin,
-	Reference,
-	SearchResult,
-	SplitDirection,
-	TFolder,
-	ViewState,
+    CachedMetadata, CacheItem,
+    Command,
+    Component,
+    EditorPosition,
+    EditorRange,
+    EditorRangeOrCaret,
+    EditorSuggest,
+    Events,
+    HoverPopover,
+    KeymapInfo,
+    Loc,
+    MarkdownFileInfo,
+    MarkdownSubView,
+    MarkdownViewModeType,
+    Plugin,
+    Reference,
+    SearchResult,
+    SplitDirection,
+    TFolder,
+    ViewState,
 } from "obsidian";
 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 +122,7 @@ declare module "obsidian" {
 		| "showLineNumber"
 		| "showUnsupportedFiles"
 		| "showViewHeader"
+        | "showRibbon"
 		| "smartIndentList"
 		| "spellcheck"
 		| "spellcheckLanguages"
@@ -182,8 +189,14 @@ declare module "obsidian" {
 
 	/** @todo Documentation incomplete */
 	type TreeItem<T> = TreeNode<T> & {
-		collapseEl: HTMLElement;
-		collapsed: boolean;
+        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;
@@ -383,7 +396,7 @@ declare module "obsidian" {
 		 * @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 +795,10 @@ declare module "obsidian" {
 		 * Editor > Show line numbers
 		 */
 		showLineNumber?: false | boolean;
+        /**
+         * Appearance > Show ribbon 
+         */
+        showRibbon?: true | boolean;
 		/**
 		 * Files & Links > Detect all file extensions
 		 */
@@ -954,6 +971,10 @@ declare module "obsidian" {
 		/** @internal */
 		cache: unknown;
 	}
+    
+    interface CachedMetadata {
+        footnotes?: FootnoteCache[];
+    }
 
 	interface CanvasConnection {}
 
@@ -1865,6 +1886,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 +2117,10 @@ 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 +2165,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 +2225,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 +2242,8 @@ declare module "obsidian" {
 		 * @param command
 		 */
 		printHotkeyForCommand(command: string): string;
+        /** @internal */
+        registerListeners(): void;
 		/**
 		 * Remove a hotkey from the default hotkeys
 		 *
@@ -2244,6 +2286,12 @@ declare module "obsidian" {
 		display: string;
 	}
 
+    /** @todo Documentation incomplete */
+    interface HoverPopover {
+        /** @internal */
+        watchResize(): void;
+    }
+
 	class IFramedMarkdownEditor extends MarkdownScrollableEditView {
 		constructor(context: WidgetEditorView);
 		/**
@@ -2319,6 +2367,11 @@ declare module "obsidian" {
 	interface InternalPlugin extends Plugin {
 		disable(): void;
 		enable(): void;
+		instance: InternalPluginInstance<this>;
+	}
+
+	interface InternalPluginInstance<TPlugin> {
+		plugin: TPlugin;
 	}
 
 	interface InternalPlugins extends Events {
@@ -2350,9 +2403,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 +3032,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 +3066,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
 		 */
@@ -3776,6 +3832,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 */
@@ -4529,6 +4589,12 @@ declare module "obsidian" {
 		 */
 		useSelectedItem(event: Event): boolean;
 	}
+    
+    /** @todo Documentation incomplete */
+    interface SuggestModal<T> {
+        /** @internal */
+        clearButtonEl: HTMLButtonElement;
+    }
 
 	/** @todo Documentation incomplete */
 	interface TableCell {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "obsidian-typings",
-    "version": "1.1.2",
+    "version": "1.1.4",
     "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
     "main": "",
     "types": "obsidian-ex.d.ts",
@@ -20,12 +20,12 @@
         "url": "https://github.com/Fevol/obsidian-typings/issues"
     },
     "homepage": "https://github.com/Fevol/obsidian-typings#readme",
-    "dependencies": {
-        "obsidian": "^1.4.11"
-    },
-    "devDependencies": {
+    "peerDependencies": {
         "@types/node": "^20.10.7",
         "@types/electron": "npm:@ophidian/electron-types",
+        "obsidian": "^1.5.7-1"
+    },
+    "devDependencies": {
         "dprint": "^0.45.1",
         "ts-morph": "^22.0.0"
     },