obsidian-typings 2.2.0 → 2.2.1-beta.1

package/dist/implementations.d.ts

@@ -3,7 +3,7 @@
 import * as fs from 'node:fs';
 import * as fsPromises from 'node:fs/promises';
 import * as path from 'node:path';
-import { TAbstractFile, TFile, TFolder, Vault } from 'obsidian';
+import { FileStats, TAbstractFile, TFile, TFolder, Vault } from 'obsidian';
 
 /**
  * Creates and properly initializes the instance of TFolder even the underlying folder does not exist.
@@ -305,6 +305,8 @@ export interface AppVaultConfig {
 /** @public */
 export type ConfigItem = "accentColor" | "alwaysUpdateLinks" | "attachmentFolderPath" | "autoConvertHtml" | "autoPairBrackets" | "autoPairMarkdown" | "baseFontSize" | "baseFontSizeAction" | "cssTheme" | "defaultViewMode" | "emacsyKeys" | "enabledCssSnippets" | "fileSortOrder" | "focusNewTab" | "foldHeading" | "foldIndent" | "hotkeys" | "interfaceFontFamily" | "legacyEditor" | "livePreview" | "mobilePullAction" | "mobileQuickRibbonItem" | "mobileToolbarCommands" | "monospaceFontFamily" | "nativeMenus" | "newFileFolderPath" | "newFileLocation" | "newLinkFormat" | "pdfExportSettings" | "promptDelete" | "propertiesInDocument" | "readableLineLength" | "rightToLeft" | "showIndentGuide" | "showInlineTitle" | "showLineNumber" | "showUnsupportedFiles" | "showViewHeader" | "showRibbon" | "smartIndentList" | "spellcheck" | "spellcheckLanguages" | "strictLineBreaks" | "tabSize" | "textFontFamily" | "theme" | "translucency" | "trashOption" | "types" | "useMarkdownLinks" | "useTab" | "userIgnoreFilters" | "vimMode";
 /** @public */
+export type FileSystemWatchHandler = (eventType: string, path: string, oldPath?: string, stats?: FileStats) => void;
+/** @public */
 export interface VaultFileMapRecord extends Record<string, TAbstractFile> {
 }
 /** @public */

package/dist/obsidian-typings.api.json

@@ -18168,6 +18168,41 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "obsidian-typings!FileSystemWatchHandler:type",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type FileSystemWatchHandler = "
+            },
+            {
+              "kind": "Content",
+              "text": "(eventType: string, path: string, oldPath?: string, stats?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "FileStats",
+              "canonicalReference": "obsidian!FileStats:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/obsidian/internals/FileSystemWatchHandler.d.ts",
+          "releaseTag": "Public",
+          "name": "FileSystemWatchHandler",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
         {
           "kind": "Interface",
           "canonicalReference": "obsidian-typings!FileTreeItem:interface",
@@ -22832,7 +22867,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "obsidian-typings!LinkUpdateHandler:type",
-          "docComment": "",
+          "docComment": "/**\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",

package/dist/types.d.ts

@@ -6,7 +6,7 @@ import { IpcRenderer } from 'electron';
 import * as fs from 'node:fs';
 import * as fsPromises from 'node:fs/promises';
 import * as path from 'node:path';
-import { App, BlockCache, CachedMetadata, Command, Component, Constructor, EditableFileView, Editor, EditorPosition, EditorRange, EditorSuggest, EventRef, Events, FileView, HoverLinkSource, HoverPopover, ItemView, KeymapInfo, Loc, MarkdownFileInfo, MarkdownPreviewView, MarkdownView, PaneType, Plugin as Plugin$1, PluginManifest, Reference, ReferenceCache, Scope, SearchComponent, SearchResult, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextFileView, Vault, View, ViewState, Workspace, WorkspaceLeaf } from 'obsidian';
+import { App, BlockCache, CachedMetadata, Command, Component, Constructor, EditableFileView, Editor, EditorPosition, EditorRange, EditorSuggest, EventRef, Events, FileStats, FileView, HoverLinkSource, HoverPopover, ItemView, KeymapInfo, Loc, MarkdownFileInfo, MarkdownPreviewView, MarkdownView, PaneType, Plugin as Plugin$1, PluginManifest, Reference, ReferenceCache, Scope, SearchComponent, SearchResult, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextFileView, Vault, View, ViewState, Workspace, WorkspaceLeaf } from 'obsidian';
 
 declare module "obsidian" {
 	interface BlockSubpathResult extends SubpathResult {
@@ -103,6 +103,7 @@ export interface LinkUpdate {
 	 */
 	sourceFile: TFile;
 }
+/** @public */
 export type LinkUpdateHandler = (link: LinkUpdate) => void | Promise<void>;
 /** @todo Documentation incomplete */
 /** @public */
@@ -704,6 +705,8 @@ export interface AppVaultConfig {
 /** @public */
 export type ConfigItem = "accentColor" | "alwaysUpdateLinks" | "attachmentFolderPath" | "autoConvertHtml" | "autoPairBrackets" | "autoPairMarkdown" | "baseFontSize" | "baseFontSizeAction" | "cssTheme" | "defaultViewMode" | "emacsyKeys" | "enabledCssSnippets" | "fileSortOrder" | "focusNewTab" | "foldHeading" | "foldIndent" | "hotkeys" | "interfaceFontFamily" | "legacyEditor" | "livePreview" | "mobilePullAction" | "mobileQuickRibbonItem" | "mobileToolbarCommands" | "monospaceFontFamily" | "nativeMenus" | "newFileFolderPath" | "newFileLocation" | "newLinkFormat" | "pdfExportSettings" | "promptDelete" | "propertiesInDocument" | "readableLineLength" | "rightToLeft" | "showIndentGuide" | "showInlineTitle" | "showLineNumber" | "showUnsupportedFiles" | "showViewHeader" | "showRibbon" | "smartIndentList" | "spellcheck" | "spellcheckLanguages" | "strictLineBreaks" | "tabSize" | "textFontFamily" | "theme" | "translucency" | "trashOption" | "types" | "useMarkdownLinks" | "useTab" | "userIgnoreFilters" | "vimMode";
 /** @public */
+export type FileSystemWatchHandler = (eventType: string, path: string, oldPath?: string, stats?: FileStats) => void;
+/** @public */
 export interface VaultFileMapRecord extends Record<string, TAbstractFile> {
 }
 declare module "obsidian" {
@@ -726,6 +729,8 @@ declare module "obsidian" {
 		configTs: number;
 		/** @internal Mapping of path to Obsidian folder or file structure */
 		fileMap: VaultFileMapRecord;
+		/** @internal Listener for all events on the vault */
+		onChange: FileSystemWatchHandler;
 		/** @internal Add file as child/parent to respective folders */
 		addChild(file: TAbstractFile): void;
 		/** @internal Check whether new file path is available */
@@ -779,8 +784,6 @@ declare module "obsidian" {
 		on(name: "config-changed", callback: () => void, ctx?: unknown): EventRef;
 		/** @internal Triggered whenever a file gets loaded internally */
 		on(name: "raw", callback: (path: string) => void, ctx?: unknown): EventRef;
-		/** @internal Listener for all events on the vault */
-		onChange(eventType: string, path: string, oldPath?: string, stats?: FileStats): void;
 		/**
 		 * Read a config file from the vault and parse it as JSON
 		 *
@@ -4543,7 +4546,7 @@ declare module "obsidian" {
 		/** @internal */
 		update(normalizedPath: string): unknown;
 		/** @internal Add change watcher to path */
-		watch(normalizedPath: string): Promise<void>;
+		watch(handler: FileSystemWatchHandler): Promise<void>;
 		/** @internal Watch recursively for changes */
 		watchHiddenRecursive(normalizedPath: string): Promise<void>;
 	}
@@ -5879,11 +5882,6 @@ export interface FileSuggest<T> extends EditorSuggest<T> {
 	 */
 	suggestManager: FileSuggestManager;
 }
-declare global {
-	interface DomElementInfo {
-		[eventName: `on${string}`]: EventListenerOrEventListenerObject;
-	}
-}
 declare module "obsidian" {
 	/** @todo Documentation incomplete */
 	interface ItemView extends View {
@@ -6376,6 +6374,51 @@ declare module "obsidian" {
 		syncState(e: boolean): Promise<unknown>;
 	}
 }
+/** @todo Documentation incomplete */
+/** @public */
+export interface VimState {
+	vim: {
+		inputState: {
+			changeQueue: null;
+			keyBuffer: [
+			];
+			motion: null;
+			motionArgs: null;
+			motionRepeat: [
+			];
+			operator: null;
+			operatorArgs: null;
+			prefixRepeat: [
+			];
+			registerName: null;
+		};
+		insertMode: false;
+		insertModeRepeat: undefined;
+		lastEditActionCommand: undefined;
+		lastEditInputState: undefined;
+		lastHPos: number;
+		lastHSPos: number;
+		lastMotion: {
+			name?: string;
+		};
+		lastPastedText: null;
+		lastSelection: null;
+	};
+	vimPlugin: {
+		lastKeydown: string;
+	};
+}
+/** @todo Documentation incomplete */
+/** @public */
+export interface VimEditor {
+	state: VimState;
+}
+declare module "@codemirror/view" {
+	/** @todo Documentation incomplete */
+	interface EditorView {
+		cm?: VimEditor;
+	}
+}
 /** @public */
 export interface ImageView extends EditableFileView {
 	/**
@@ -6923,49 +6966,9 @@ export interface GraphView extends ItemView {
 	 */
 	onOptionsChange(): void;
 }
-/** @todo Documentation incomplete */
-/** @public */
-export interface VimState {
-	vim: {
-		inputState: {
-			changeQueue: null;
-			keyBuffer: [
-			];
-			motion: null;
-			motionArgs: null;
-			motionRepeat: [
-			];
-			operator: null;
-			operatorArgs: null;
-			prefixRepeat: [
-			];
-			registerName: null;
-		};
-		insertMode: false;
-		insertModeRepeat: undefined;
-		lastEditActionCommand: undefined;
-		lastEditInputState: undefined;
-		lastHPos: number;
-		lastHSPos: number;
-		lastMotion: {
-			name?: string;
-		};
-		lastPastedText: null;
-		lastSelection: null;
-	};
-	vimPlugin: {
-		lastKeydown: string;
-	};
-}
-/** @todo Documentation incomplete */
-/** @public */
-export interface VimEditor {
-	state: VimState;
-}
-declare module "@codemirror/view" {
-	/** @todo Documentation incomplete */
-	interface EditorView {
-		cm?: VimEditor;
+declare global {
+	interface DomElementInfo {
+		[eventName: `on${string}`]: EventListenerOrEventListenerObject;
 	}
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "obsidian-typings",
-    "version": "2.2.0",
+    "version": "2.2.1-beta.1",
     "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
     "main": "",
     "module": "",
@@ -71,6 +71,7 @@
         "build:style-mod": "bun run scripts/build-style-mod.ts",
         "build:extract-api": "api-extractor run --local",
         "format": "bun run scripts/sort-interfaces.ts ./src/ && bun dprint fmt",
+        "release-beta": "bun run scripts/bump-version.ts beta",
         "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",