@obsidian-typings/obsidian-catalyst-1.14.4 1.2.0 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 1.4.0
+
+- feat: add the FrontmatterValue augmentation, and fail the build on an export without one
+
+## 1.3.0
+
+- feat: reconcile with the obsidian 1.14.4 public API
+
 ## 1.2.0
 
 ### Breaking changes

package/dist/cjs/types.d.cts

@@ -6667,6 +6667,7 @@ declare module "obsidian" {
 		 * Get the editor instance.
 		 *
 		 * @returns The editor instance.
+		 * @deprecated Use the editor directly. Kept for compatibility with CodeMirror 5.
 		 * @official
 		 * @since 0.11.11
 		 */
@@ -7304,7 +7305,7 @@ declare module "obsidian" {
 		/**
 		 * Close the menu.
 		 *
-		 * @returns The menu instance.
+		 * @deprecated Previously existed to satisfy ClosableComponent.
 		 * @official
 		 */
 		close(): void;
@@ -7405,6 +7406,12 @@ declare module "obsidian" {
 		 * @official
 		 */
 		onHide(callback: () => unknown): void;
+		/**
+		 * Called when the user navigates back in the history.
+		 *
+		 * @official
+		 */
+		onHistoryBack(): void;
 		/**
 		 * Preemptively closes the menu if click is registered on menu item.
 		 *
@@ -13802,6 +13809,16 @@ declare module "obsidian" {
 	 */
 	export function addIcon(iconId: string, svgContent: string): void;
 }
+declare module "obsidian" {
+	/**
+	 * All possible types that can be emitted from parsing or writing to frontmatter.
+	 *
+	 * @deprecated - Added only for typing purposes. Use {@link FrontmatterValue} instead.
+	 */
+	type FrontmatterValue__ = {
+		[key: string]: FrontmatterValue;
+	} | boolean | FrontmatterValue[] | null | number | string | undefined;
+}
 declare module "obsidian" {
 	/**
 	 * An instance of `Moment.js` library.
@@ -14129,6 +14146,12 @@ declare module "obsidian" {
 		 * @unofficial
 		 */
 		onEscapeKey(): void;
+		/**
+		 * Called when the user navigates back in the history.
+		 *
+		 * @official
+		 */
+		onHistoryBack(): void;
 		/**
 		 * Called after every selection change, including the programmatic one that follows
 		 * {@link SuggestModalChooser.setSuggestions}.
@@ -15759,6 +15782,14 @@ declare module "obsidian" {
 		 * @since 1.10.0
 		 */
 		groupBy?: BasesConfigFileViewGroupBy;
+		/**
+		 * Ordered list of the groupBy values to show. When set, only these groups appear, in this order.
+		 * `null` is the group of entries with no value.
+		 *
+		 * @official
+		 * @since 1.14.3
+		 */
+		groupOrder?: FrontmatterValue[];
 		/**
 		 * Friendly name for this view, displayed in the UI to select between views.
 		 *
@@ -18073,6 +18104,16 @@ declare module "obsidian" {
 		offset: number;
 	}
 }
+declare module "obsidian" {
+	/**
+	 * Logical sidedock identity, independent of screen position. In LTR, `'primary'`
+	 * renders on the left and `'secondary'` on the right; RTL mirrors them.
+	 * `'left'` and `'right'` are legacy aliases for `'primary'` and `'secondary'`.
+	 *
+	 * @deprecated - Added only for typing purposes. Use {@link Side} instead.
+	 */
+	type Side__ = "left" | "primary" | "right" | "secondary";
+}
 declare module "obsidian" {
 	/**
 	 * Manage the creation, deletion and renaming of files from the UI.
@@ -19174,12 +19215,12 @@ declare module "obsidian" {
 		 * 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.
+		 * @param frontmatterProcessor - A function to modify the frontmatter, called with the frontmatter and the created file.
 		 * @returns A promise that resolves when the file is created.
 		 * @official
 		 * @since 1.10.2
 		 */
-		createFileForView(baseFileName?: string, frontmatterProcessor?: (frontmatter: unknown) => void): Promise<void>;
+		createFileForView(baseFileName?: string, frontmatterProcessor?: (frontmatter: unknown, file: TFile) => void): Promise<void>;
 		/**
 		 * Creates the heading element for a result group.
 		 *
@@ -19645,6 +19686,25 @@ declare module "obsidian" {
 		text: string;
 	}
 }
+declare module "obsidian" {
+	/**
+	 * Represents a file that is outside the Vault.
+	 * Can be used with the vault API just like any other file.
+	 * Do not create these manually.
+	 *
+	 * @since 1.14.4
+	 */
+	interface TExternalFile extends TFile {
+		/**
+		 * Returns the physical path in the filesystem.
+		 *
+		 * @returns The physical path in the filesystem.
+		 * @official
+		 * @since 1.14.4
+		 */
+		getRealPath(): string;
+	}
+}
 declare module "obsidian" {
 	/**
 	 * Represents a point in a 2D coordinate system.
@@ -23426,14 +23486,6 @@ declare module "obsidian" {
 		scope: Scope;
 	}
 }
-declare module "obsidian" {
-	/**
-	 * The side of the leaf.
-	 *
-	 * @deprecated - Added only for typing purposes. Use {@link Side} instead.
-	 */
-	type Side__ = "left" | "right";
-}
 declare module "obsidian" {
 	/**
 	 * The state of a popover.
@@ -27778,6 +27830,12 @@ declare module "obsidian" {
 		 * @unofficial
 		 */
 		onEscapeKey(): void;
+		/**
+		 * Called when the user navigates back in the history.
+		 *
+		 * @official
+		 */
+		onHistoryBack(): void;
 		/**
 		 * Called when the modal is opened.
 		 *

package/dist/esm/types.d.mts

@@ -6667,6 +6667,7 @@ declare module "obsidian" {
 		 * Get the editor instance.
 		 *
 		 * @returns The editor instance.
+		 * @deprecated Use the editor directly. Kept for compatibility with CodeMirror 5.
 		 * @official
 		 * @since 0.11.11
 		 */
@@ -7304,7 +7305,7 @@ declare module "obsidian" {
 		/**
 		 * Close the menu.
 		 *
-		 * @returns The menu instance.
+		 * @deprecated Previously existed to satisfy ClosableComponent.
 		 * @official
 		 */
 		close(): void;
@@ -7405,6 +7406,12 @@ declare module "obsidian" {
 		 * @official
 		 */
 		onHide(callback: () => unknown): void;
+		/**
+		 * Called when the user navigates back in the history.
+		 *
+		 * @official
+		 */
+		onHistoryBack(): void;
 		/**
 		 * Preemptively closes the menu if click is registered on menu item.
 		 *
@@ -13802,6 +13809,16 @@ declare module "obsidian" {
 	 */
 	export function addIcon(iconId: string, svgContent: string): void;
 }
+declare module "obsidian" {
+	/**
+	 * All possible types that can be emitted from parsing or writing to frontmatter.
+	 *
+	 * @deprecated - Added only for typing purposes. Use {@link FrontmatterValue} instead.
+	 */
+	type FrontmatterValue__ = {
+		[key: string]: FrontmatterValue;
+	} | boolean | FrontmatterValue[] | null | number | string | undefined;
+}
 declare module "obsidian" {
 	/**
 	 * An instance of `Moment.js` library.
@@ -14129,6 +14146,12 @@ declare module "obsidian" {
 		 * @unofficial
 		 */
 		onEscapeKey(): void;
+		/**
+		 * Called when the user navigates back in the history.
+		 *
+		 * @official
+		 */
+		onHistoryBack(): void;
 		/**
 		 * Called after every selection change, including the programmatic one that follows
 		 * {@link SuggestModalChooser.setSuggestions}.
@@ -15759,6 +15782,14 @@ declare module "obsidian" {
 		 * @since 1.10.0
 		 */
 		groupBy?: BasesConfigFileViewGroupBy;
+		/**
+		 * Ordered list of the groupBy values to show. When set, only these groups appear, in this order.
+		 * `null` is the group of entries with no value.
+		 *
+		 * @official
+		 * @since 1.14.3
+		 */
+		groupOrder?: FrontmatterValue[];
 		/**
 		 * Friendly name for this view, displayed in the UI to select between views.
 		 *
@@ -18073,6 +18104,16 @@ declare module "obsidian" {
 		offset: number;
 	}
 }
+declare module "obsidian" {
+	/**
+	 * Logical sidedock identity, independent of screen position. In LTR, `'primary'`
+	 * renders on the left and `'secondary'` on the right; RTL mirrors them.
+	 * `'left'` and `'right'` are legacy aliases for `'primary'` and `'secondary'`.
+	 *
+	 * @deprecated - Added only for typing purposes. Use {@link Side} instead.
+	 */
+	type Side__ = "left" | "primary" | "right" | "secondary";
+}
 declare module "obsidian" {
 	/**
 	 * Manage the creation, deletion and renaming of files from the UI.
@@ -19174,12 +19215,12 @@ declare module "obsidian" {
 		 * 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.
+		 * @param frontmatterProcessor - A function to modify the frontmatter, called with the frontmatter and the created file.
 		 * @returns A promise that resolves when the file is created.
 		 * @official
 		 * @since 1.10.2
 		 */
-		createFileForView(baseFileName?: string, frontmatterProcessor?: (frontmatter: unknown) => void): Promise<void>;
+		createFileForView(baseFileName?: string, frontmatterProcessor?: (frontmatter: unknown, file: TFile) => void): Promise<void>;
 		/**
 		 * Creates the heading element for a result group.
 		 *
@@ -19645,6 +19686,25 @@ declare module "obsidian" {
 		text: string;
 	}
 }
+declare module "obsidian" {
+	/**
+	 * Represents a file that is outside the Vault.
+	 * Can be used with the vault API just like any other file.
+	 * Do not create these manually.
+	 *
+	 * @since 1.14.4
+	 */
+	interface TExternalFile extends TFile {
+		/**
+		 * Returns the physical path in the filesystem.
+		 *
+		 * @returns The physical path in the filesystem.
+		 * @official
+		 * @since 1.14.4
+		 */
+		getRealPath(): string;
+	}
+}
 declare module "obsidian" {
 	/**
 	 * Represents a point in a 2D coordinate system.
@@ -23426,14 +23486,6 @@ declare module "obsidian" {
 		scope: Scope;
 	}
 }
-declare module "obsidian" {
-	/**
-	 * The side of the leaf.
-	 *
-	 * @deprecated - Added only for typing purposes. Use {@link Side} instead.
-	 */
-	type Side__ = "left" | "right";
-}
 declare module "obsidian" {
 	/**
 	 * The state of a popover.
@@ -27778,6 +27830,12 @@ declare module "obsidian" {
 		 * @unofficial
 		 */
 		onEscapeKey(): void;
+		/**
+		 * Called when the user navigates back in the history.
+		 *
+		 * @official
+		 */
+		onHistoryBack(): void;
 		/**
 		 * Called when the modal is opened.
 		 *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@obsidian-typings/obsidian-catalyst-1.14.4",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
   "keywords": [
     "obsdmd",
@@ -74,6 +74,7 @@
     "build:implementations": "jiti scripts/build-implementations.ts",
     "build:implementations:bundle-types": "jiti scripts/build-implementations-bundle-types.ts",
     "build:implementations:generate-types": "jiti scripts/build-implementations-generate-types.ts",
+    "build:validate-augmentation-coverage": "jiti scripts/build-validate-augmentation-coverage.ts",
     "build:validate-bundle": "jiti scripts/build-validate-bundle.ts",
     "build:validate-bundle-types": "jiti scripts/build-validate-bundle-types.ts",
     "build:validate-types": "jiti scripts/build-validate-types.ts",