obsidian-typings 4.99.0 → 4.100.0

package/dist/cjs/types.d.cts

@@ -4772,6 +4772,14 @@ declare module "obsidian" {
 		isRoot(): boolean;
 	}
 }
+declare module "obsidian" {
+	/**
+	 * A function that handles CLI commands.
+	 *
+	 * @deprecated - Added only for typing purposes. Use {@link CliHandler} instead.
+	 */
+	type CliHandler__ = (params: CliData) => string | Promise<string>;
+}
 declare module "obsidian" {
 	/**
 	 * A group of BasesEntry objects for a given value of the groupBy key.
@@ -4884,6 +4892,14 @@ declare module "obsidian" {
 		watchResize(): void;
 	}
 }
+declare module "obsidian" {
+	/**
+	 * A map of CLI flags.
+	 *
+	 * @deprecated - Added only for typing purposes. Use {@link CliFlag} instead.
+	 */
+	type CliFlags__ = Record<string, CliFlag>;
+}
 declare module "obsidian" {
 	/**
 	 * A menu item.
@@ -5465,13 +5481,6 @@ declare module "obsidian" {
 	 * @since 1.11.4
 	 */
 	interface SecretStorage {
-		/**
-		 * Gets the last access timestamp for a secret key
-		 * @param id The secret ID
-		 * @returns Timestamp in milliseconds, or null if never accessed
-		 * @official
-		 */
-		getLastAccess(id: string): number | null;
 		/**
 		 * Gets a secret from storage
 		 *
@@ -9609,6 +9618,20 @@ declare module "obsidian" {
 		 * @since 1.10.0
 		 */
 		registerBasesView(viewId: string, registration: BasesViewRegistration): boolean;
+		/**
+		 * Register a CLI handler to handle a command from the CLI.
+		 * Command IDs must be globally unique. Attempting to register a command that is already registered will throw an Error.
+		 *
+		 * Use the format `<plugin-id>` for your default command, and `<plugin-id>:<action>` for sub-commands and actions.
+		 *
+		 * @param command - The command ID that will be used. Use alphanumeric characters without spaces.
+		 * @param description - The description text to provide in the help command, and in auto-completion prompts.
+		 * @param flags - Command line flags that can be passed in.
+		 * @param handler - The callback handler to handle a CLI invocation.
+		 * @official
+		 * @since 1.12.2
+		 */
+		registerCliHandler(command: string, description: string, flags: CliFlags | null, handler: CliHandler): void;
 		/**
 		 * Registers a CodeMirror 6 extension.
 		 * To reconfigure cm6 extensions for a plugin on the fly, an array should be passed in, and modified dynamically.
@@ -12472,12 +12495,19 @@ declare module "obsidian" {
 		 */
 		processFrontMatter(file: TFile, fn: (frontmatter: any) => void, options?: DataWriteOptions): Promise<void>;
 		/**
-		 * Prompt the user to delete a file.
+		 * Prompt the user to confirm they want to delete the specified file or folder.
 		 *
-		 * @unofficial
+		 * @param file - the file or folder to delete.
+		 * @returns A promise that resolves to `true` if the prompt was confirmed or `false` if it was canceled.
+		 * @example
+		 * ```ts
+		 * const file = app.vault.getFileByPath('foo/bar.md');
+		 * await app.fileManager.promptForDeletion(file);
+		 * ```
+		 * @official
 		 * @since 0.15.0
 		 */
-		promptForDeletion(file: TAbstractFile): Promise<void>;
+		promptForDeletion(file: TAbstractFile): Promise<boolean>;
 		/**
 		 * Prompt the user to delete a file.
 		 *
@@ -14471,6 +14501,35 @@ declare module "obsidian" {
 		file: TFile;
 	}
 }
+declare module "obsidian" {
+	/**
+	 * The data passed to the CLI.
+	 */
+	export interface CliData extends Record<string, string | "true"> {
+	}
+}
+declare module "obsidian" {
+	/**
+	 * The data passed to the CLI.
+	 */
+	export interface CliFlag {
+		/**
+		 * Description shown in help and autocomplete
+		 * @official
+		 */
+		description: string;
+		/**
+		 * Whether this flag is required (default: false)
+		 * @official
+		 */
+		required?: boolean;
+		/**
+		 * Value placeholder (e.g., '<filename>', '<path>'). Omit for boolean flags.
+		 * @official
+		 */
+		value?: string;
+	}
+}
 declare module "obsidian" {
 	/**
 	 * The direction of the leaf split.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-typings",
-  "version": "4.99.0",
+  "version": "4.100.0",
   "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
   "main": "",
   "module": "",
@@ -74,7 +74,7 @@
     "electron": "39.2.7",
     "i18next": "25.2.1",
     "mermaid": "11.4.1",
-    "obsidian": "1.12.0",
+    "obsidian": "1.12.2",
     "pdfjs-dist": "5.3.31",
     "pixi.js": "7.2.4",
     "scrypt-js": "3.0.1",