obsidian-typings 1.1.1 → 1.1.2

package/obsidian-ex.d.ts

@@ -851,6 +851,100 @@ 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`
+     */
+	interface BaseEditor {
+		/**
+		 * CodeMirror editor instance
+		 */
+		cm: EditorView;
+		/**
+		 * HTML instance the CM editor is attached to
+		 */
+		containerEl: HTMLElement;
+
+		/**
+		 * Clean-up function executed after indenting lists
+		 */
+		afterIndent(): void;
+		/**
+		 * Expand text
+		 *
+		 * @internal
+		 */
+		expandText(): void;
+		/**
+		 * Indents a list by one level
+		 */
+		indentList(): void;
+		/**
+		 * Insert a template callout at the current cursor position
+		 */
+		insertCallout(): void;
+		/**
+		 * Insert a template code block at the current cursor position
+		 */
+		insertCodeblock(): void;
+		/**
+		 * Insert a markdown link at the current cursor position
+		 */
+		insertLink(): void;
+		/**
+		 * Insert a mathjax equation block at the current cursor position
+		 */
+		insertMathJax(): void;
+		/**
+		 * Insert specified text at the current cursor position
+		 *
+		 * @remark Might be broken, inserts at the end of the document
+		 */
+		insertText(text: string): void;
+		/**
+		 * Inserts a new line and continues a markdown bullet point list at the same level
+		 */
+		newlineAndIndentContinueMarkdownList(): void;
+		/**
+		 * Inserts a new line at the same indent level
+		 */
+		newlineAndIndentOnly(): void;
+		/**
+		 * Get the character position at a mouse event
+		 */
+		posAtMouse(e: MouseEvent): EditorPosition;
+		/**
+		 * Toggles blockquote syntax on paragraph under cursor
+		 */
+		toggleBlockquote(): void;
+		/**
+		 * Toggle bullet point list syntax on paragraph under cursor
+		 */
+		toggleBulletList(): void;
+		/**
+		 * Toggle checkbox syntax on paragraph under cursor
+		 */
+		toggleCheckList(): void;
+		/**
+		 * Toggle numbered list syntax on paragraph under cursor
+		 */
+		toggleNumberList(): void;
+		/**
+		 * Convert word under cursor into a wikilink
+		 *
+		 * @param embed Whether to embed the link or not
+		 */
+		triggerWikiLink(embed: boolean): void;
+		/**
+		 * Unindents a list by one level
+		 */
+		unindentList(): void;
+	}
+
 	/** @todo Documentation incomplete */
 	interface BlockCache {
 		/**
@@ -1296,90 +1390,100 @@ declare module "obsidian" {
 		fileBeingRenamed: null | TFile;
 	}
 
-	interface Editor {
-		/**
-		 * CodeMirror editor instance
-		 */
-		cm: EditorView;
-		/**
-		 * HTML instance the CM editor is attached to
-		 */
-		containerEl: HTMLElement;
-
+	interface Editor extends BaseEditor {
 		/**
-		 * Clean-up function executed after indenting lists
+		 * Linked Editor manager instance
 		 */
-		afterIndent(): void;
+		editorComponent: undefined | MarkdownScrollableEditView;
 		/**
-		 * Expand text
+		 * Currently active CM instance
 		 *
-		 * @internal
-		 */
-		expandText(): void;
-		/**
-		 * Indents a list by one level
+		 * @remark Can be null when Editor is not instantiated
 		 */
-		indentList(): void;
+		get activeCm(): EditorView | null;
 		/**
-		 * Insert a template callout at the current cursor position
+		 * Whether the editor is embedded in a table cell
 		 */
-		insertCallout(): void;
+		get inTableCell(): boolean;
+
 		/**
-		 * Insert a template code block at the current cursor position
+		 * Make ranges of text highlighted within the editor given specified class (style)
 		 */
-		insertCodeblock(): void;
+		addHighlights(
+			ranges: EditorRange[],
+			style: "is-flashing" | "obsidian-search-match-highlight",
+			remove_previous: boolean,
+			range?: EditorSelection,
+		): void;
 		/**
-		 * Insert a markdown link at the current cursor position
+		 * Convert editor position to screen position
+		 *
+		 * @param pos Editor position
+		 * @param relative_to_editor Relative to the editor or the application window
 		 */
-		insertLink(): void;
+		coordsAtPos(
+			pos: EditorPosition,
+			relative_to_editor: boolean,
+		): { left: number; top: number; bottom: number; right: number };
 		/**
-		 * Insert a mathjax equation block at the current cursor position
+		 * Unfolds all folded lines one level up
+		 *
+		 * @remark If level 1 and 2 headings are folded, level 2 headings will be unfolded
 		 */
-		insertMathJax(): void;
+		foldLess(): void;
 		/**
-		 * Insert specified text at the current cursor position
+		 * Folds all the blocks that are of the lowest unfolded level
 		 *
-		 * @remark Might be broken, inserts at the end of the document
+		 * @remark If there is a document with level 1 and 2 headings, level 2 headings will be folded
 		 */
-		insertText(text: string): void;
+		foldMore(): void;
 		/**
-		 * Inserts a new line and continues a markdown bullet point list at the same level
+		 * Get all ranges that can be folded away in the editor
 		 */
-		newlineAndIndentContinueMarkdownList(): void;
+		getAllFoldableLines(): { from: number; to: number }[];
 		/**
-		 * Inserts a new line at the same indent level
+		 * Get a clickable link - if it exists - at specified position
 		 */
-		newlineAndIndentOnly(): void;
+		getClickableTokenAt(pos: EditorPosition): {
+			start: EditorPosition;
+			end: EditorPosition;
+			text: string;
+			type: string;
+		} | null;
 		/**
-		 * Get the character position at a mouse event
+		 * Get all blocks that were folded by their starting character position
 		 */
-		posAtMouse(e: MouseEvent): EditorPosition;
+		getFoldOffsets(): Set<number>;
 		/**
-		 * Toggles blockquote syntax on paragraph under cursor
+		 * Checks whether the editor has a highlight of specified class
+		 *
+		 * @remark If no style is specified, checks whether the editor has unknown highlights
 		 */
-		toggleBlockquote(): void;
+		hasHighlight(style?: string): boolean;
 		/**
-		 * Toggle bullet point list syntax on paragraph under cursor
+		 * Wraps current line around specified characters
+		 *
+		 * @remark Was added in a recent Obsidian update (1.4.0 update cycle)
 		 */
-		toggleBulletList(): void;
+		insertBlock(start: string, end: string): void;
 		/**
-		 * Toggle checkbox syntax on paragraph under cursor
+		 * Get the closest character position to the specified coordinates
 		 */
-		toggleCheckList(): void;
+		posAtCoords(coords: { left: number; top: number }): EditorPosition;
 		/**
-		 * Toggle numbered list syntax on paragraph under cursor
+		 * Removes all highlights of specified class
 		 */
-		toggleNumberList(): void;
+		removeHighlights(style: string): void;
 		/**
-		 * Convert word under cursor into a wikilink
-		 *
-		 * @param embed Whether to embed the link or not
+		 * Adds a search cursor to the editor
 		 */
-		triggerWikiLink(embed: boolean): void;
+		searchCursor(searchString: string): SearchCursor;
 		/**
-		 * Unindents a list by one level
+		 * Applies specified markdown syntax to selected text or word under cursor
 		 */
-		unindentList(): void;
+		toggleMarkdownFormatting(
+			syntax: "bold" | "italic" | "strikethrough" | "highlight" | "code" | "math" | "comment",
+		): void;
 	}
 
 	interface EditorSearchComponent extends AbstractSearchComponent {
@@ -1390,7 +1494,7 @@ declare module "obsidian" {
 		/**
 		 * Linked editor for search component
 		 */
-		editor: ExtendedEditor;
+		editor: Editor;
 		/**
 		 * Whether search component is currently rendering
 		 */
@@ -1714,102 +1818,6 @@ declare module "obsidian" {
 		fn(...arg: unknown[]): void;
 	}
 
-	interface ExtendedEditor extends Editor {
-		/**
-		 * Linked Editor manager instance
-		 */
-		editorComponent: undefined | MarkdownScrollableEditView;
-		/**
-		 * Currently active CM instance
-		 *
-		 * @remark Can be null when Editor is not instantiated
-		 */
-		get activeCm(): EditorView | null;
-		/**
-		 * Whether the editor is embedded in a table cell
-		 */
-		get inTableCell(): boolean;
-
-		/**
-		 * Make ranges of text highlighted within the editor given specified class (style)
-		 */
-		addHighlights(
-			ranges: EditorRange[],
-			style: "is-flashing" | "obsidian-search-match-highlight",
-			remove_previous: boolean,
-			range?: EditorSelection,
-		): void;
-		/**
-		 * Convert editor position to screen position
-		 *
-		 * @param pos Editor position
-		 * @param relative_to_editor Relative to the editor or the application window
-		 */
-		coordsAtPos(
-			pos: EditorPosition,
-			relative_to_editor: boolean,
-		): { left: number; top: number; bottom: number; right: number };
-		/**
-		 * Unfolds all folded lines one level up
-		 *
-		 * @remark If level 1 and 2 headings are folded, level 2 headings will be unfolded
-		 */
-		foldLess(): void;
-		/**
-		 * Folds all the blocks that are of the lowest unfolded level
-		 *
-		 * @remark If there is a document with level 1 and 2 headings, level 2 headings will be folded
-		 */
-		foldMore(): void;
-		/**
-		 * Get all ranges that can be folded away in the editor
-		 */
-		getAllFoldableLines(): { from: number; to: number }[];
-		/**
-		 * Get a clickable link - if it exists - at specified position
-		 */
-		getClickableTokenAt(pos: EditorPosition): {
-			start: EditorPosition;
-			end: EditorPosition;
-			text: string;
-			type: string;
-		} | null;
-		/**
-		 * Get all blocks that were folded by their starting character position
-		 */
-		getFoldOffsets(): Set<number>;
-		/**
-		 * Checks whether the editor has a highlight of specified class
-		 *
-		 * @remark If no style is specified, checks whether the editor has unknown highlights
-		 */
-		hasHighlight(style?: string): boolean;
-		/**
-		 * Wraps current line around specified characters
-		 *
-		 * @remark Was added in a recent Obsidian update (1.4.0 update cycle)
-		 */
-		insertBlock(start: string, end: string): void;
-		/**
-		 * Get the closest character position to the specified coordinates
-		 */
-		posAtCoords(coords: { left: number; top: number }): EditorPosition;
-		/**
-		 * Removes all highlights of specified class
-		 */
-		removeHighlights(style: string): void;
-		/**
-		 * Adds a search cursor to the editor
-		 */
-		searchCursor(searchString: string): SearchCursor;
-		/**
-		 * Applies specified markdown syntax to selected text or word under cursor
-		 */
-		toggleMarkdownFormatting(
-			syntax: "bold" | "italic" | "strikethrough" | "highlight" | "code" | "math" | "comment",
-		): void;
-	}
-
 	interface FileCacheEntry {
 		/**
 		 * Hash of file contents
@@ -2507,7 +2515,7 @@ declare module "obsidian" {
 		 *
 		 * @remark Handles formatting, table creation, highlight adding, etc.
 		 */
-		editor: ExtendedEditor;
+		editor: Editor;
 		/**
 		 * Element in which the CodeMirror editor resides
 		 */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "obsidian-typings",
-    "version": "1.1.1",
+    "version": "1.1.2",
     "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
     "main": "",
     "types": "obsidian-ex.d.ts",