obsidian-dev-utils 18.4.0 → 19.0.0

package/dist/lib/obsidian/Components/index.mjs

@@ -0,0 +1,44 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function initEsm(){if(globalThis.process){return}const browserProcess={browser:true,cwd:__name(()=>"/","cwd"),env:{},platform:"android"};globalThis.process=browserProcess})();
+
+import * as DateComponent from "./DateComponent.mjs";
+import * as DateTimeComponent from "./DateTimeComponent.mjs";
+import * as EmailComponent from "./EmailComponent.mjs";
+import * as FileComponent from "./FileComponent.mjs";
+import * as MonthComponent from "./MonthComponent.mjs";
+import * as MultipleDropdownComponent from "./MultipleDropdownComponent.mjs";
+import * as MultipleEmailComponent from "./MultipleEmailComponent.mjs";
+import * as MultipleFileComponent from "./MultipleFileComponent.mjs";
+import * as MultipleTextComponent from "./MultipleTextComponent.mjs";
+import * as NumberComponent from "./NumberComponent.mjs";
+import * as TimeComponent from "./TimeComponent.mjs";
+import * as TypedRangeTextComponent from "./TypedRangeTextComponent.mjs";
+import * as TypedTextComponent from "./TypedTextComponent.mjs";
+import * as UrlComponent from "./UrlComponent.mjs";
+import * as ValidatorComponent from "./ValidatorComponent.mjs";
+import * as ValueComponentWithChangeTracking from "./ValueComponentWithChangeTracking.mjs";
+import * as WeekComponent from "./WeekComponent.mjs";
+export {
+  DateComponent,
+  DateTimeComponent,
+  EmailComponent,
+  FileComponent,
+  MonthComponent,
+  MultipleDropdownComponent,
+  MultipleEmailComponent,
+  MultipleFileComponent,
+  MultipleTextComponent,
+  NumberComponent,
+  TimeComponent,
+  TypedRangeTextComponent,
+  TypedTextComponent,
+  UrlComponent,
+  ValidatorComponent,
+  ValueComponentWithChangeTracking,
+  WeekComponent
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL0NvbXBvbmVudHMvaW5kZXgudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qIFRISVMgSVMgQSBHRU5FUkFURUQvQlVORExFRCBGSUxFIEJZIEJVSUxEIFNDUklQVCAqL1xuXG5leHBvcnQgKiBhcyBEYXRlQ29tcG9uZW50IGZyb20gJy4vRGF0ZUNvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBEYXRlVGltZUNvbXBvbmVudCBmcm9tICcuL0RhdGVUaW1lQ29tcG9uZW50LnRzJztcbmV4cG9ydCAqIGFzIEVtYWlsQ29tcG9uZW50IGZyb20gJy4vRW1haWxDb21wb25lbnQudHMnO1xuZXhwb3J0ICogYXMgRmlsZUNvbXBvbmVudCBmcm9tICcuL0ZpbGVDb21wb25lbnQudHMnO1xuZXhwb3J0ICogYXMgTW9udGhDb21wb25lbnQgZnJvbSAnLi9Nb250aENvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBNdWx0aXBsZURyb3Bkb3duQ29tcG9uZW50IGZyb20gJy4vTXVsdGlwbGVEcm9wZG93bkNvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBNdWx0aXBsZUVtYWlsQ29tcG9uZW50IGZyb20gJy4vTXVsdGlwbGVFbWFpbENvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBNdWx0aXBsZUZpbGVDb21wb25lbnQgZnJvbSAnLi9NdWx0aXBsZUZpbGVDb21wb25lbnQudHMnO1xuZXhwb3J0ICogYXMgTXVsdGlwbGVUZXh0Q29tcG9uZW50IGZyb20gJy4vTXVsdGlwbGVUZXh0Q29tcG9uZW50LnRzJztcbmV4cG9ydCAqIGFzIE51bWJlckNvbXBvbmVudCBmcm9tICcuL051bWJlckNvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBUaW1lQ29tcG9uZW50IGZyb20gJy4vVGltZUNvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBUeXBlZFJhbmdlVGV4dENvbXBvbmVudCBmcm9tICcuL1R5cGVkUmFuZ2VUZXh0Q29tcG9uZW50LnRzJztcbmV4cG9ydCAqIGFzIFR5cGVkVGV4dENvbXBvbmVudCBmcm9tICcuL1R5cGVkVGV4dENvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBVcmxDb21wb25lbnQgZnJvbSAnLi9VcmxDb21wb25lbnQudHMnO1xuZXhwb3J0ICogYXMgVmFsaWRhdG9yQ29tcG9uZW50IGZyb20gJy4vVmFsaWRhdG9yQ29tcG9uZW50LnRzJztcbmV4cG9ydCAqIGFzIFZhbHVlQ29tcG9uZW50V2l0aENoYW5nZVRyYWNraW5nIGZyb20gJy4vVmFsdWVDb21wb25lbnRXaXRoQ2hhbmdlVHJhY2tpbmcudHMnO1xuZXhwb3J0ICogYXMgV2Vla0NvbXBvbmVudCBmcm9tICcuL1dlZWtDb21wb25lbnQudHMnO1xuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7OztBQUVBLFlBQVksbUJBQW1CO0FBQy9CLFlBQVksdUJBQXVCO0FBQ25DLFlBQVksb0JBQW9CO0FBQ2hDLFlBQVksbUJBQW1CO0FBQy9CLFlBQVksb0JBQW9CO0FBQ2hDLFlBQVksK0JBQStCO0FBQzNDLFlBQVksNEJBQTRCO0FBQ3hDLFlBQVksMkJBQTJCO0FBQ3ZDLFlBQVksMkJBQTJCO0FBQ3ZDLFlBQVkscUJBQXFCO0FBQ2pDLFlBQVksbUJBQW1CO0FBQy9CLFlBQVksNkJBQTZCO0FBQ3pDLFlBQVksd0JBQXdCO0FBQ3BDLFlBQVksa0JBQWtCO0FBQzlCLFlBQVksd0JBQXdCO0FBQ3BDLFlBQVksc0NBQXNDO0FBQ2xELFlBQVksbUJBQW1COyIsCiAgIm5hbWVzIjogW10KfQo=

package/dist/lib/obsidian/{Dataview.d.ts → Dataview.d.cts}

@@ -2,15 +2,15 @@
  * @packageDocumentation Dataview
  * This module provides utility functions for working with Dataview in Obsidian.
  */
-import type { MaybePromise } from '../Async.ts';
-import type { DataviewInlineApi as DataviewInlineApiOriginal } from './@types/Dataview/api/inline-api.d.ts';
-import type { DataArray, DataviewApi, SMarkdownPage } from './@types/Dataview/index.d.ts';
-import type { PathOrFile } from './FileSystem.ts';
-import type { CombinedFrontmatter } from './Frontmatter.ts';
+import type { MaybePromise } from '../Async.cjs';
+import type { DataviewInlineApi as DataviewInlineApiOriginal } from './@types/Dataview/api/inline-api.d.cjs';
+import type { DataArray, DataviewApi, SMarkdownPage } from './@types/Dataview/index.d.cjs';
+import type { PathOrFile } from './FileSystem.cjs';
+import type { CombinedFrontmatter } from './Frontmatter.cjs';
 /**
  * Export DateTime and Link types from the Dataview API.
  */
-export type { DateTime, Link } from './@types/Dataview/index.d.ts';
+export type { DateTime, Link } from './@types/Dataview/index.d.cjs';
 declare global {
     /**
      * The DataviewAPI object represents the API for interacting with Dataview in Obsidian.

package/dist/lib/obsidian/Dataview.d.mts

@@ -0,0 +1,215 @@
+/**
+ * @packageDocumentation Dataview
+ * This module provides utility functions for working with Dataview in Obsidian.
+ */
+import type { MaybePromise } from '../Async.mjs';
+import type { DataviewInlineApi as DataviewInlineApiOriginal } from './@types/Dataview/api/inline-api.d.mjs';
+import type { DataArray, DataviewApi, SMarkdownPage } from './@types/Dataview/index.d.mjs';
+import type { PathOrFile } from './FileSystem.mjs';
+import type { CombinedFrontmatter } from './Frontmatter.mjs';
+/**
+ * Export DateTime and Link types from the Dataview API.
+ */
+export type { DateTime, Link } from './@types/Dataview/index.d.mjs';
+declare global {
+    /**
+     * The DataviewAPI object represents the API for interacting with Dataview in Obsidian.
+     */
+    var DataviewAPI: DataviewApi | undefined;
+}
+/**
+ * The combined page type, which includes the front matter and the SMarkdownPage.
+ */
+export type CombinedPage<CustomFrontmatter = unknown> = CombinedFrontmatter<CustomFrontmatter> & SMarkdownPage;
+/**
+ * Extended interface for the Dataview Inline API, providing additional methods for custom page types and array handling.
+ *
+ * @typeParam CustomPage - The type of the custom page. Defaults to `SMarkdownPage`.
+ */
+export interface DataviewInlineApi extends DataviewInlineApiOriginal {
+    /**
+     * Wraps an array of items into a `DataArray` object.
+     *
+     * @typeParam T - The type of the items in the array.
+     * @param arr - The array of items to wrap.
+     * @returns A `DataArray` containing the items.
+     */
+    array<T>(arr: T[]): DataArray<T>;
+    /**
+     * Retrieves the current page, with an optional custom page type.
+     *
+     * @typeParam CustomPage - The type of the custom page. Defaults to `SMarkdownPage`.
+     * @returns The current page.
+     */
+    current<CustomFrontmatter = unknown>(): CombinedPage<CustomFrontmatter>;
+    /**
+     * Retrieves pages based on an optional query, with an optional custom page type.
+     *
+     * @typeParam CustomPage - The type of the custom page. Defaults to `SMarkdownPage`.
+     * @param query - An optional string query to filter the pages.
+     * @returns A `DataArray` of pages matching the query.
+     */
+    pages<CustomFrontmatter = unknown>(query?: string): DataArray<CombinedPage<CustomFrontmatter>>;
+    /**
+     * Creates a paragraph HTML element with the provided text and optional DOM element options.
+     *
+     * @param text - The content of the paragraph.
+     * @param options - Optional DOM element options, including an optional container.
+     * @returns The created HTML paragraph element.
+     */
+    paragraph(text: unknown, options?: DomElementInfoWithContainer): HTMLParagraphElement;
+}
+/**
+ * DomElementInfo with an optional container.
+ */
+export type DomElementInfoWithContainer = {
+    container?: HTMLElement;
+} & DomElementInfo;
+/**
+ * The combined file type, which includes the front matter and the SMarkdownFile.
+ */
+export type PageFile = SMarkdownPage['file'];
+/**
+ * List of page files.
+ */
+export type PageFiles = ArrayOrDataArray<PageFile>;
+/**
+ * Reloads the current file cache using the Dataview API.
+ *
+ * @param dv - The DataviewInlineApi instance.
+ * @returns A promise that resolves when the cache is reloaded.
+ */
+export declare function reloadCurrentFileCache(dv: DataviewInlineApi): Promise<void>;
+/**
+ * Array or DataArray type.
+ */
+export type ArrayOrDataArray<T> = DataArray<T> | T[];
+/**
+ * Options for rendering an iframe in the Dataview container.
+ */
+export interface RenderIframeOptions {
+    /**
+     * The DataviewInlineApi instance.
+     */
+    dv: DataviewInlineApi;
+    /**
+     * The height of the iframe.
+     */
+    height: string;
+    /**
+     * The relative path to the resource to be displayed in the iframe.
+     */
+    relativePathOrFile: PathOrFile;
+    /**
+     * The width of the iframe.
+     */
+    width: string;
+}
+/**
+ * Options for rendering a paginated list using the Dataview API.
+ */
+export interface RenderPaginatedListOptions<T> {
+    /**
+     * The DataviewInlineApi instance.
+     */
+    dv: DataviewInlineApi;
+    /**
+     * Options for items per page. Defaults to `[10, 20, 50, 100]`.
+     */
+    itemsPerPageOptions?: number[];
+    /**
+     * The list of items to paginate.
+     */
+    rows: ArrayOrDataArray<T>;
+}
+/**
+ * Options for rendering a paginated element using the Dataview API.
+ */
+export interface RenderPaginatedOptions<T> {
+    /**
+     * The DataviewInlineApi instance.
+     */
+    dv: DataviewInlineApi;
+    /**
+     * Options for items per page.
+     */
+    itemsPerPageOptions: number[];
+    /**
+     * The renderer function to display the paginated content.
+     * @param rowsForOnePage - The rows to render.
+     * @returns A promise that resolves when the content is rendered.
+     */
+    renderer: (rowsForOnePage: ArrayOrDataArray<T>) => MaybePromise<void>;
+    /**
+     * The rows to paginate.
+     */
+    rows: ArrayOrDataArray<T>;
+}
+/**
+ * Options for rendering a paginated table using the Dataview API.
+ */
+export interface RenderPaginatedTableOptions<T> {
+    /**
+     * The DataviewInlineApi instance.
+     */
+    dv: DataviewInlineApi;
+    /**
+     * The headers of the table.
+     */
+    headers: string[];
+    /**
+     * Options for items per page. Defaults to `[10, 20, 50, 100]`.
+     */
+    itemsPerPageOptions?: number[];
+    /**
+     * The rows of the table to paginate.
+     */
+    rows: ArrayOrDataArray<T>;
+}
+/**
+ * Renders the content using the provided renderer function in a temporary container,
+ * and then returns the container.
+ *
+ * @param dv - The DataviewInlineApi instance.
+ * @param renderer - The function responsible for rendering the content.
+ * @returns A promise that resolves to the HTML paragraph element
+ * that was used as the temporary container.
+ */
+export declare function getRenderedContainer(dv: DataviewInlineApi, renderer: () => MaybePromise<void>): Promise<HTMLParagraphElement>;
+/**
+ * Inserts a code block into the specified Dataview instance using the provided language and code.
+ *
+ * @param dv - The DataviewInlineApi instance to insert the code block into.
+ * @param language - The language identifier for the code block.
+ * @param code - The code content to be inserted into the code block.
+ * @returns This function does not return a value.
+ */
+export declare function insertCodeBlock(dv: DataviewInlineApi, language: string, code: string): void;
+/**
+ * Renders an iframe in the Dataview container with the specified relative path, width, and height.
+ *
+ * @param options - The options for rendering the iframe.
+ *
+ * @returns This function does not return a value.
+ */
+export declare function renderIframe(options: RenderIframeOptions): void;
+/**
+ * Renders a paginated list using the provided DataviewInlineApi instance.
+ *
+ * @typeParam T - The type of items in the list.
+ *
+ * @param options - The options for rendering the paginated list.
+ *
+ * @returns A promise that resolves when the list is rendered.
+ */
+export declare function renderPaginatedList<T>(options: RenderPaginatedListOptions<T>): Promise<void>;
+/**
+ * Renders a paginated table using the provided DataviewInlineApi instance.
+ *
+ * @typeParam T - The type of items in the table rows.
+ *
+ * @param options - The options for rendering the paginated table.
+ *
+ * @returns A promise that resolves when the table is rendered.
+ */
+export declare function renderPaginatedTable<T extends unknown[]>(options: RenderPaginatedTableOptions<T>): Promise<void>;

package/dist/lib/obsidian/{DataviewLink.d.ts → DataviewLink.d.cts}

@@ -2,8 +2,8 @@
  * @packageDocumentation DataviewLink
  * This module provides utility functions for working with Dataview links in Obsidian
  */
-import type { DataviewInlineApi, Link } from './Dataview.ts';
-import type { PathOrFile } from './FileSystem.ts';
+import type { DataviewInlineApi, Link } from './Dataview.cjs';
+import type { PathOrFile } from './FileSystem.cjs';
 /**
  * Fixes the title of a file or folder note by generating a `Link` object with a proper title.
  *

package/dist/lib/obsidian/DataviewLink.d.mts

@@ -0,0 +1,23 @@
+/**
+ * @packageDocumentation DataviewLink
+ * This module provides utility functions for working with Dataview links in Obsidian
+ */
+import type { DataviewInlineApi, Link } from './Dataview.mjs';
+import type { PathOrFile } from './FileSystem.mjs';
+/**
+ * Fixes the title of a file or folder note by generating a `Link` object with a proper title.
+ *
+ * @param dv - The DataviewInlineApi instance used to create the file link.
+ * @param pathOrFile - The file path for which the title is to be fixed.
+ * @param isFolderNote - A boolean indicating whether the file is a folder note. Defaults to `false`.
+ * If true, the title is derived from the folder name. Defaults to `false`.
+ * @returns A Link object with the corrected title.
+ */
+export declare function fixTitle(dv: DataviewInlineApi, pathOrFile: PathOrFile, isFolderNote?: boolean): Link;
+/**
+ * Generates a string representation of a `Link` object that includes both the link text and the file path.
+ *
+ * @param link - The Link object to be converted to a string with its path.
+ * @returns A string representing the link in the format: "linkText (linkPath)".
+ */
+export declare function makeLinkWithPath(link: Link): string;

package/dist/lib/obsidian/{FileChange.d.ts → FileChange.d.cts}

@@ -3,9 +3,9 @@
  * Contains utility types and functions for handling file changes in Obsidian.
  */
 import type { App } from 'obsidian';
-import type { ValueProvider } from '../ValueProvider.ts';
-import type { PathOrFile } from './FileSystem.ts';
-import type { ProcessOptions } from './Vault.ts';
+import type { ValueProvider } from '../ValueProvider.cjs';
+import type { PathOrFile } from './FileSystem.cjs';
+import type { ProcessOptions } from './Vault.cjs';
 /**
  * Represents a content body change in the Vault.
  */

package/dist/lib/obsidian/FileChange.d.mts

@@ -0,0 +1,68 @@
+/**
+ * @packageDocumentation FileChange
+ * Contains utility types and functions for handling file changes in Obsidian.
+ */
+import type { App } from 'obsidian';
+import type { ValueProvider } from '../ValueProvider.mjs';
+import type { PathOrFile } from './FileSystem.mjs';
+import type { ProcessOptions } from './Vault.mjs';
+/**
+ * Represents a content body change in the Vault.
+ */
+export interface ContentChange extends FileChange {
+    /**
+     * The end index of the change in the file content.
+     */
+    endIndex: number;
+    /**
+     * The start index of the change in the file content.
+     */
+    startIndex: number;
+}
+/**
+ * Represents a file change in the Vault.
+ */
+export interface FileChange {
+    /**
+     * The new content to replace the old content.
+     */
+    newContent: string;
+    /**
+     * The old content that will be replaced.
+     */
+    oldContent: string;
+}
+/**
+ * Represents a frontmatter change in the Vault.
+ */
+export interface FrontmatterChange extends FileChange {
+    /**
+     * The key in the frontmatter to use for the link.
+     */
+    frontmatterKey: string;
+}
+/**
+ * Applies a series of file changes to the specified file or path within the application.
+ *
+ * @param app - The application instance where the file changes will be applied.
+ * @param pathOrFile - The path or file to which the changes should be applied.
+ * @param changesProvider - A provider that returns an array of file changes to apply.
+ * @param processOptions - Optional options for processing/retrying the operation.
+ *
+ * @returns A promise that resolves when the file changes have been successfully applied.
+ */
+export declare function applyFileChanges(app: App, pathOrFile: PathOrFile, changesProvider: ValueProvider<FileChange[]>, processOptions?: ProcessOptions): Promise<void>;
+/**
+ * Checks if a file change is a content change.
+ *
+ * @param fileChange - The file change to check.
+ * @returns A boolean indicating whether the file change is a content change.
+ */
+export declare function isContentChange(fileChange: FileChange): fileChange is ContentChange;
+/**
+ * Checks if a file change is a frontmatter change.
+ *
+ * @param fileChange - The file change to check.
+ * @returns A boolean indicating whether the file change is a frontmatter change.
+ */
+export declare function isFrontmatterChange(fileChange: FileChange): fileChange is FrontmatterChange;

package/dist/lib/obsidian/{FileManager.d.ts → FileManager.d.cts}

@@ -3,10 +3,10 @@
  * Contains utility functions for managing files in Obsidian.
  */
 import type { App } from 'obsidian';
-import type { MaybePromise } from '../Async.ts';
-import type { PathOrFile } from './FileSystem.ts';
-import type { CombinedFrontmatter } from './Frontmatter.ts';
-import type { ProcessOptions } from './Vault.ts';
+import type { MaybePromise } from '../Async.cjs';
+import type { PathOrFile } from './FileSystem.cjs';
+import type { CombinedFrontmatter } from './Frontmatter.cjs';
+import type { ProcessOptions } from './Vault.cjs';
 /**
  * Adds an alias to the front matter of a given file if it does not already exist.
  *

package/dist/lib/obsidian/FileManager.d.mts

@@ -0,0 +1,38 @@
+/**
+ * @packageDocumentation FileManager
+ * Contains utility functions for managing files in Obsidian.
+ */
+import type { App } from 'obsidian';
+import type { MaybePromise } from '../Async.mjs';
+import type { PathOrFile } from './FileSystem.mjs';
+import type { CombinedFrontmatter } from './Frontmatter.mjs';
+import type { ProcessOptions } from './Vault.mjs';
+/**
+ * Adds an alias to the front matter of a given file if it does not already exist.
+ *
+ * @param app - The Obsidian app instance.
+ * @param pathOrFile - The path or TFile object representing the note.
+ * @param alias - The alias to add.
+ * @returns A promise that resolves when the alias has been added.
+ */
+export declare function addAlias(app: App, pathOrFile: PathOrFile, alias?: string): Promise<void>;
+/**
+ * Deletes an alias from the front matter of a given file if it exists.
+ *
+ * @param app - The Obsidian app instance.
+ * @param pathOrFile - The path or TFile object representing the note.
+ * @param alias - The alias to delete.
+ * @returns A promise that resolves when the alias has been deleted.
+ */
+export declare function deleteAlias(app: App, pathOrFile: PathOrFile, alias?: string): Promise<void>;
+/**
+ * Processes the front matter of a given file, allowing modifications via a provided function.
+ *
+ * @typeParam CustomFrontmatter - The type of custom front matter.
+ * @param app - The Obsidian app instance.
+ * @param pathOrFile - The path or TFile object representing the note.
+ * @param frontmatterFn - A function that modifies the front matter.
+ * @param processOptions - Optional. Configuration options for retrying the process. If not provided, default options will be used.
+ * @returns A promise that resolves when the front matter has been processed and saved.
+ */
+export declare function processFrontmatter<CustomFrontmatter = unknown>(app: App, pathOrFile: PathOrFile, frontmatterFn: (frontmatter: CombinedFrontmatter<CustomFrontmatter>) => MaybePromise<null | void>, processOptions?: ProcessOptions): Promise<void>;

package/dist/lib/obsidian/FileSystem.d.mts

@@ -0,0 +1,185 @@
+/**
+ * @packageDocumentation FileSystem
+ * This module provides utility functions for working with TAbstractFile, TFile, and TFolder instances in Obsidian.
+ */
+import { App, TAbstractFile, TFile, TFolder } from 'obsidian';
+/**
+ * The file extension for Markdown files.
+ */
+export declare const MARKDOWN_FILE_EXTENSION = "md";
+/**
+ * Represents the file extension for canvas files.
+ */
+export declare const CANVAS_FILE_EXTENSION = "canvas";
+/**
+ * Represents a path or an instance of TAbstractFile.
+ */
+export type PathOrAbstractFile = string | TAbstractFile;
+/**
+ * Represents a path or a file.
+ */
+export type PathOrFile = string | TFile;
+/**
+ * Represents a path or an instance of TFolder.
+ */
+export type PathOrFolder = string | TFolder;
+/**
+ * Checks if the given path or file has the specified extension.
+ *
+ * @param app - The Obsidian App instance.
+ * @param pathOrFile - The path or abstract file to check.
+ * @param extension - The extension to compare against.
+ * @returns Returns `true` if the path or file has the specified extension, `false` otherwise.
+ */
+export declare function checkExtension(app: App, pathOrFile: null | PathOrAbstractFile, extension: string): boolean;
+/**
+ * Retrieves the TAbstractFile object for the given path or abstract file.
+ *
+ * @param app - The App instance.
+ * @param pathOrFile - The path or abstract file to retrieve the TAbstractFile for.
+ * @param isCaseInsensitive - Specifies whether to perform a case-insensitive search. Default is `false`.
+ * @returns The TAbstractFile object.
+ * @throws Error if the abstract file is not found.
+ */
+export declare function getAbstractFile(app: App, pathOrFile: PathOrAbstractFile, isCaseInsensitive?: boolean): TAbstractFile;
+/**
+ * Retrieves an instance of TAbstractFile or null based on the provided path or abstract file.
+ *
+ * @param app - The application instance.
+ * @param pathOrFile - The path or abstract file to retrieve.
+ * @param isCaseInsensitive - Specifies whether to perform a case-insensitive search. Default is `false`.
+ * @returns The instance of TAbstractFile if found, otherwise null.
+ */
+export declare function getAbstractFileOrNull(app: App, pathOrFile: null | PathOrAbstractFile, isCaseInsensitive?: boolean): null | TAbstractFile;
+/**
+ * Retrieves a TFile object based on the provided path or file.
+ *
+ * @param app - The Obsidian App instance.
+ * @param pathOrFile - The path or file to retrieve the TFile object for.
+ * @param shouldIncludeNonExisting - Whether to include a non-existing file.
+ *  If `true`, a new TFile object is created for the provided path.
+ *  If `false`, an error is thrown if the file is not found.
+ * @param isCaseInsensitive - Specifies whether to perform a case-insensitive search. Default is `false`.
+ * @returns The TFile object corresponding to the provided path or file.
+ * @throws Error if the file is not found.
+ */
+export declare function getFile(app: App, pathOrFile: PathOrFile, shouldIncludeNonExisting?: boolean, isCaseInsensitive?: boolean): TFile;
+/**
+ * Retrieves a TFile object based on the provided path or file.
+ * If the provided argument is already a TFile object, it is returned as is.
+ * Otherwise, the function uses the app's vault to retrieve the TFile object by its path.
+ * @param app - The Obsidian App instance.
+ * @param pathOrFile - The path or TFile object.
+ * @param isCaseInsensitive - Specifies whether to perform a case-insensitive search. Default is `false`.
+ * @returns The TFile object if found, otherwise null.
+ */
+export declare function getFileOrNull(app: App, pathOrFile: null | PathOrFile, isCaseInsensitive?: boolean): null | TFile;
+/**
+ * Retrieves a TFolder object based on the provided app and pathOrFolder.
+ *
+ * @param app - The Obsidian app instance.
+ * @param pathOrFolder - The path or folder identifier.
+ * @param shouldIncludeNonExisting - Whether to allow the folder to not exist.
+ *  If `true`, a new TFolder object is created for the provided path.
+ *  If `false`, an error is thrown if the folder is not found.
+ * @param isCaseInsensitive - Specifies whether to perform a case-insensitive search. Default is `false`.
+ * @returns The retrieved TFolder object.
+ * @throws If the folder is not found.
+ */
+export declare function getFolder(app: App, pathOrFolder: PathOrFolder, shouldIncludeNonExisting?: boolean, isCaseInsensitive?: boolean): TFolder;
+/**
+ * Retrieves a TFolder object or null based on the provided path or folder.
+ *
+ * @param app - The Obsidian application instance.
+ * @param pathOrFolder - The path or folder to retrieve the TFolder from.
+ * @param isCaseInsensitive - Specifies whether to perform a case-insensitive search. Default is `false`.
+ * @returns The TFolder object if found, otherwise null.
+ */
+export declare function getFolderOrNull(app: App, pathOrFolder: null | PathOrFolder, isCaseInsensitive?: boolean): null | TFolder;
+/**
+ * Retrieves an array of TFile objects representing the markdown files within a specified folder or path.
+ *
+ * @param app - The Obsidian App instance.
+ * @param pathOrFolder - The path or folder to retrieve the markdown files from.
+ * @param isRecursive - Optional. Specifies whether to recursively search for markdown files within subfolders. Default is false.
+ * @returns An array of TFile objects representing the markdown files.
+ */
+export declare function getMarkdownFiles(app: App, pathOrFolder: PathOrFolder, isRecursive?: boolean): TFile[];
+/**
+ * Retrieves the TFile object for the given path or creates a new one if it does not exist.
+ *
+ * @param app - The Obsidian App instance.
+ * @param path - The path of the file to retrieve or create.
+ * @returns The TFile object representing the file
+ */
+export declare function getOrCreateFile(app: App, path: string): Promise<TFile>;
+/**
+ * Retrieves the TFolder object for the given path or creates a new one if it does not exist.
+ *
+ * @param app - The Obsidian App instance.
+ * @param path - The path of the folder to retrieve or create.
+ * @returns The TFolder object representing the folder.
+ */
+export declare function getOrCreateFolder(app: App, path: string): Promise<TFolder>;
+/**
+ * Returns the path of the given `pathOrFile`.
+ *
+ * @param app - The Obsidian App instance.
+ * @param pathOrFile - The path or abstract file.
+ * @returns The path of the `pathOrFile`.
+ */
+export declare function getPath(app: App, pathOrFile: PathOrAbstractFile): string;
+/**
+ * Checks if the given file is an instance of TAbstractFile.
+ *
+ * @param file - The file to check.
+ * @returns A boolean indicating whether the file is an instance of TAbstractFile.
+ */
+export declare function isAbstractFile(file: unknown): file is TAbstractFile;
+/**
+ * Checks if the given file is a canvas file.
+ *
+ * @param app - The Obsidian App instance.
+ * @param pathOrFile - The path or file to check.
+ * @returns A boolean indicating whether the file is a canvas file or not.
+ */
+export declare function isCanvasFile(app: App, pathOrFile: null | PathOrAbstractFile): boolean;
+/**
+ * Checks if the given file is an instance of TFile.
+ *
+ * @param file - The file to check.
+ * @returns A boolean indicating whether the file is an instance of TFile.
+ */
+export declare function isFile(file: unknown): file is TFile;
+/**
+ * Checks if the given file is a folder.
+ *
+ * @param file - The file to check.
+ * @returns `true` if the file is a folder, `false` otherwise.
+ */
+export declare function isFolder(file: unknown): file is TFolder;
+/**
+ * Checks if the given file is a Markdown file.
+ *
+ * @param app - The Obsidian App instance.
+ * @param pathOrFile - The path or file to check.
+ * @returns A boolean indicating whether the file is a Markdown file.
+ */
+export declare function isMarkdownFile(app: App, pathOrFile: null | PathOrAbstractFile): boolean;
+/**
+ * Checks if the given file is a note.
+ *
+ * @param app - The Obsidian App instance.
+ * @param pathOrFile - The path or file to check.
+ * @returns A boolean indicating whether the file is a note.
+ */
+export declare function isNote(app: App, pathOrFile: null | PathOrAbstractFile): boolean;
+/**
+ * Trims the markdown extension from the file path if the file is a markdown file.
+ * If the file is not a markdown file, the original file path is returned.
+ *
+ * @param app - The Obsidian App instance.
+ * @param file - The file to trim the markdown extension from.
+ * @returns The file path with the markdown extension trimmed.
+ */
+export declare function trimMarkdownExtension(app: App, file: TAbstractFile): string;