obsidian-typings 4.59.0 → 4.60.0

package/dist/cjs/types.d.cts

@@ -4252,7 +4252,7 @@ declare module "obsidian" {
 		 */
 		register(cb: () => any): void;
 		/**
-		 * Registers an DOM event to be detached when unloading.
+		 * Registers a DOM event to be detached when unloading.
 		 *
 		 * @typeParam K - The type of the event to register.
 		 * @param el - The element to register the event on.
@@ -4270,7 +4270,7 @@ declare module "obsidian" {
 		 */
 		registerDomEvent<K extends keyof DocumentEventMap>(el: Document, type: K, callback: (this: HTMLElement, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
 		/**
-		 * Registers an DOM event to be detached when unloading.
+		 * Registers a DOM event to be detached when unloading.
 		 *
 		 * @typeParam K - The type of the event to register.
 		 * @param el - The element to register the event on.
@@ -4287,7 +4287,7 @@ declare module "obsidian" {
 		 */
 		registerDomEvent<K extends keyof HTMLElementEventMap>(el: HTMLElement, type: K, callback: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
 		/**
-		 * Registers an DOM event to be detached when unloading.
+		 * Registers a DOM event to be detached when unloading.
 		 *
 		 * @typeParam K - The type of the event to register.
 		 * @param el - The element to register the event on.
@@ -6296,6 +6296,114 @@ declare module "obsidian" {
 		constructor__(containerEl: HTMLElement): this;
 	}
 }
+declare module "obsidian" {
+	/**
+	 * A text input allowing selection of a file from in the vault.
+	 *
+	 * @since 1.10.2
+	 */
+	export interface FileOption extends BaseOption {
+		/**
+		 * The default value of the option.
+		 *
+		 * @official
+		 * @since 1.10.2
+		 */
+		default?: string;
+		/**
+		 * Filter the files to be displayed in the file picker.
+		 *
+		 * @param file - The file to filter.
+		 * @returns `true` if the file should be displayed, `false` otherwise.
+		 * @official
+		 * @since 1.10.2
+		 */
+		filter?: (file: TFile) => boolean;
+		/**
+		 * The placeholder of the option.
+		 *
+		 * @official
+		 * @since 1.10.2
+		 */
+		placeholder?: string;
+		/**
+		 * The type of the option.
+		 *
+		 * @official
+		 * @since 1.10.2
+		 */
+		type: "file";
+	}
+}
+declare module "obsidian" {
+	/**
+	 * A text input allowing selection of a folder from in the vault.
+	 *
+	 * @since 1.10.2
+	 */
+	export interface FolderOption extends BaseOption {
+		/**
+		 * The default value of the option.
+		 *
+		 * @official
+		 * @since 1.10.2
+		 */
+		default?: string;
+		/**
+		 * Filter the folders to be displayed in the folder picker.
+		 *
+		 * @param folder - The folder to filter.
+		 * @returns `true` if the folder should be displayed, `false` otherwise.
+		 * @official
+		 * @since 1.10.2
+		 */
+		filter?: (folder: TFolder) => boolean;
+		/**
+		 * The placeholder of the option.
+		 *
+		 * @official
+		 * @since 1.10.2
+		 */
+		placeholder?: string;
+		/**
+		 * The type of the option.
+		 *
+		 * @official
+		 * @since 1.10.2
+		 */
+		type: "folder";
+	}
+}
+declare module "obsidian" {
+	/**
+	 * A text input supporting formula evaluation.
+	 *
+	 * @since 1.10.2
+	 */
+	export interface FormulaOption extends BaseOption {
+		/**
+		 * The default value of the option.
+		 *
+		 * @official
+		 * @since 1.10.2
+		 */
+		default?: string;
+		/**
+		 * The placeholder of the option.
+		 *
+		 * @official
+		 * @since 1.10.2
+		 */
+		placeholder?: string;
+		/**
+		 * The type of the option.
+		 *
+		 * @official
+		 * @since 1.10.2
+		 */
+		type: "formula";
+	}
+}
 declare module "obsidian" {
 	/**
 	 * A toggle component.
@@ -9805,6 +9913,15 @@ declare module "obsidian" {
 		 * @since 1.10.0
 		 */
 		key: string;
+		/**
+		 * If provided, the option will be hidden if the function returns true.
+		 *
+		 * @param config - Read-only copy of the current view configuration.
+		 * @returns `true` if the option should be hidden, false otherwise.
+		 * @official
+		 * @since 1.10.2
+		 */
+		shouldHide?: (config: BasesViewConfig) => boolean;
 		/**
 		 * Type
 		 * @official
@@ -10093,6 +10210,15 @@ declare module "obsidian" {
 		 * @since 1.10.0
 		 */
 		items: Exclude<ViewOption, GroupOption>[];
+		/**
+		 * If provided, the group will be hidden if the function returns true.
+		 *
+		 * @param config - Read-only copy of the current view configuration.
+		 * @returns `true` if the group should be hidden, `false` otherwise.
+		 * @official
+		 * @since 1.10.2
+		 */
+		shouldHide?: (config: BasesViewConfig) => boolean;
 		/**
 		 * Type.
 		 *
@@ -10281,12 +10407,14 @@ declare module "obsidian" {
 		 * });
 		 * ```
 		 * @official
+		 * @since 0.9.7
 		 */
 		onChange(callback: (value: string) => any): this;
 		/**
 		 * Manually invokes the callback registered with `onChange`.
 		 *
 		 * @official
+		 * @since 0.9.21
 		 */
 		onChanged(): void;
 		/**
@@ -10312,6 +10440,7 @@ declare module "obsidian" {
 		 * textComponent.setPlaceholder('foo');
 		 * ```
 		 * @official
+		 * @since 0.9.7
 		 */
 		setPlaceholder(placeholder: string): this;
 		/**
@@ -10412,17 +10541,24 @@ declare module "obsidian" {
 		 */
 		renderTo(el: HTMLElement, ctx: RenderContext): void;
 		/**
-			 * Get the string representation of this Value.
-			 *
-			 * @returns The string representation of this Value.
-			 * @since 1.10.0
-			 * @deprecated - Added only for typing purposes. Use {@link Value.toString} instead.
-			 *
-			@unofficial ERROR: Missing `@unofficial` or `@official` tag
-			 */
+		 * Get the string representation of this Value.
+		 *
+		 * @returns The string representation of this Value.
+		 * @deprecated - Added only for typing purposes. Use {@link Value.toString} instead.
+		 * @official
+		 * @since 1.10.0
+		 */
 		toString__(): string;
 	}
 	namespace Value {
+		/**
+		 * The type of the value.
+		 *
+		 * @official
+		 * @since 1.10.0
+		 * @deprecated - Added only for typing purposes. Use {@link Value.type} instead.
+		 */
+		let type__: string;
 		/**
 		 * Equals.
 		 *
@@ -11274,7 +11410,7 @@ declare module "obsidian" {
 		 */
 		getName(): string;
 		/**
-		 * Returns an URI for the browser engine to use, for example to embed an image.
+		 * Returns a URI for the browser engine to use, for example to embed an image.
 		 *
 		 * @param normalizedPath - The path to get the resource path for.
 		 * @returns A URI for the browser engine to use.
@@ -11627,7 +11763,7 @@ declare module "obsidian" {
 		 */
 		getNativePath(normalizedPath: string): string;
 		/**
-		 * Returns an URI for the browser engine to use, for example to embed an image.
+		 * Returns a URI for the browser engine to use, for example to embed an image.
 		 *
 		 * @param normalizedPath - The path to get the resource path for.
 		 * @returns A URI for the browser engine to use.
@@ -12814,6 +12950,16 @@ declare module "obsidian" {
 		 * @deprecated - Added only for typing purposes. Use {@link constructor} instead.
 		 */
 		constructor__(controller: QueryController): this;
+		/**
+		 * Display the new note menu for a file with the provided filename and optionally a function to modify the frontmatter.
+		 *
+		 * @param baseFileName - The filename of the base file.
+		 * @param frontmatterProcessor - A function to modify the frontmatter.
+		 * @returns A promise that resolves when the file is created.
+		 * @official
+		 * @since 1.10.2
+		 */
+		createFileForView(baseFileName: string, frontmatterProcessor?: (frontmatter: any) => void): Promise<void>;
 		/**
 		 * Called when there is new data for the query. This view should rerender with the updated data.
 		 * @official
@@ -13477,7 +13623,7 @@ declare module "obsidian" {
 	 */
 	interface BasesQueryResult {
 		/**
-		 * A ungrouped version of the data, with user-configured sort and limit applied.
+		 * An ungrouped version of the data, with user-configured sort and limit applied.
 		 * Where appropriate, views should support groupBy by using `groupedData` instead of this value.
 		 *
 		 * @official
@@ -13788,7 +13934,7 @@ declare module "obsidian" {
 		/**
 		 * A single character indicating the checked status of a task.
 		 * The space character `' '` is interpreted as an incomplete task.
-		 * An other character is interpreted as completed task.
+		 * Any other character is interpreted as completed task.
 		 * `undefined` if this item isn't a task.
 		 *
 		 * @official
@@ -14026,6 +14172,19 @@ declare module "obsidian" {
 		 * @since 1.10.0
 		 */
 		getDisplayName(propertyId: BasesPropertyId): string;
+		/**
+		 * Retrieve a user-configured value from the config, evaluating it as a
+		 * formula in the context of the current Base. For embedded bases, or bases
+		 * in the sidebar, this means evaluating the formula against the currently
+		 * active file.
+		 *
+		 * @param view - The view to evaluate the formula in the context of.
+		 * @param key - The key to evaluate the formula for.
+		 * @returns the {@link Value} result from evaluating the formula, or {@link NullValue} if the formula is invalid, or the key is not present.
+		 * @official
+		 * @since 1.10.2
+		 */
+		getEvaluatedFormula(view: BasesView, key: string): Value;
 		/**
 		 * Ordered list of properties to display in this view.
 		 * In a table, these can be interpreted as the list of visible columns.
@@ -15684,12 +15843,11 @@ declare module "obsidian" {
 		 */
 		default?: boolean;
 		/**
-			 * Type.
-			 *
-			 * @since 1.10.0
-			 *
-			@unofficial ERROR: Missing `@unofficial` or `@official` tag
-			 */
+		 * Type.
+		 *
+		 * @official
+		 * @since 1.10.0
+		 */
 		type: "toggle";
 	}
 }
@@ -15780,7 +15938,7 @@ declare module "obsidian" {
 	 * @since 1.10.0
 	 * @deprecated - Added only for typing purposes. Use {@link ViewOption} instead.
 	 */
-	type ViewOption__ = TextOption | MultitextOption | GroupOption | PropertyOption | ToggleOption | SliderOption | DropdownOption;
+	type ViewOption__ = DropdownOption | FileOption | FolderOption | FormulaOption | GroupOption | MultitextOption | PropertyOption | SliderOption | TextOption | ToggleOption;
 }
 declare module "obsidian" {
 	/**
@@ -15902,7 +16060,7 @@ declare module "obsidian" {
 		 */
 		getRealPath(path: string): string;
 		/**
-		 * Returns an URI for the browser engine to use, for example to embed an image.
+		 * Returns a URI for the browser engine to use, for example to embed an image.
 		 *
 		 * @param normalizedPath - path to file/folder, use {@link normalizePath} to normalize beforehand.
 		 * @returns A URI for the browser engine to use.
@@ -16467,7 +16625,7 @@ declare module "obsidian" {
 		 */
 		getName(): string;
 		/**
-		 * Returns an URI for the browser engine to use, for example to embed an image.
+		 * Returns a URI for the browser engine to use, for example to embed an image.
 		 *
 		 * @param file - The file to get the resource path for.
 		 * @returns The resource path for the file.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-typings",
-  "version": "4.59.0",
+  "version": "4.60.0",
   "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
   "main": "",
   "module": "",
@@ -75,7 +75,7 @@
     "i18next": "25.2.1",
     "mermaid": "11.4.1",
     "moment": "2.29.4",
-    "obsidian": "1.10.0",
+    "obsidian": "1.10.2-1",
     "pdfjs-dist": "5.3.31",
     "pixi.js": "7.2.4",
     "scrypt-js": "3.0.1",