obsidian-dev-utils 19.1.2-beta.2 → 19.1.2-beta.4

package/dist/lib/esm/obsidian/Modals/Confirm.d.mts

@@ -1 +1,43 @@
-export * from '../../../cjs/obsidian/Modals/Confirm.cjs';
+/**
+ * @packageDocumentation Confirm
+ * Utility for displaying confirm modals in Obsidian.
+ *
+ * This module exports a function to display a modal with a message in Obsidian. The modal includes "OK" and "Cancel" buttons to confirm or cancel the action.
+ */
+import type { App } from 'obsidian';
+/**
+ * The options for the confirm modal.
+ */
+export interface ConfirmOptions {
+    /**
+     * The Obsidian app instance.
+     */
+    app: App;
+    /**
+     * The text for the "Cancel" button.
+     */
+    cancelButtonText?: string;
+    /**
+     * The CSS class to apply to the modal.
+     */
+    cssClass?: string;
+    /**
+     * The message to display in the modal.
+     */
+    message: DocumentFragment | string;
+    /**
+     * The text for the "OK" button.
+     */
+    okButtonText?: string;
+    /**
+     * The title of the modal.
+     */
+    title?: DocumentFragment | string;
+}
+/**
+ * Displays an confirm modal in Obsidian with a specified message.
+ *
+ * @param options - The options for the confirm modal.
+ * @returns A promise that resolves with a boolean indicating whether the "OK" button was clicked.
+ */
+export declare function confirm(options: ConfirmOptions): Promise<boolean>;

package/dist/lib/esm/obsidian/Modals/ModalBase.d.mts

@@ -1 +1,35 @@
-export * from '../../../cjs/obsidian/Modals/ModalBase.cjs';
+/**
+ * @packageDocumentation ModalBase
+ *
+ * This module exports a base class for displaying modals in Obsidian.
+ */
+import type { App } from 'obsidian';
+import { Modal } from 'obsidian';
+import type { PromiseResolve } from '../../Async.d.mts';
+/**
+ * The base options for a modal.
+ */
+export interface ModalOptionsBase {
+    /**
+     * The application instance.
+     */
+    app: App;
+    /**
+     * The CSS class to apply to the modal.
+     */
+    cssClass?: string;
+}
+/**
+ * A base class for displaying modals in Obsidian.
+ */
+export declare abstract class ModalBase<Value, Options extends ModalOptionsBase> extends Modal {
+    protected resolve: PromiseResolve<Value>;
+    constructor(options: Options, resolve: PromiseResolve<Value>, modalCssClass: string);
+}
+/**
+ * Displays a modal in Obsidian.
+ *
+ * @param modalCreator - A function that creates a modal.
+ * @returns A promise that resolves when the modal is closed.
+ */
+export declare function showModal<T>(modalCreator: (resolve: PromiseResolve<T>) => Modal): Promise<T>;

package/dist/lib/esm/obsidian/Modals/Prompt.d.mts

@@ -1 +1,50 @@
-export * from '../../../cjs/obsidian/Modals/Prompt.cjs';
+/**
+ * @packageDocumentation Prompt
+ * Utility for displaying a prompt modal in Obsidian.
+ *
+ * This module exports a function to display a modal that prompts the user for input. The modal includes "OK" and "Cancel" buttons.
+ */
+import type { App } from 'obsidian';
+import type { MaybePromise } from '../../Async.d.mts';
+/**
+ * The options for the prompt modal.
+ */
+export interface PromptOptions {
+    /**
+     * The Obsidian app instance.
+     */
+    app: App;
+    /**
+     * The text for the "Cancel" button.
+     */
+    cancelButtonText?: string;
+    /**
+     * The default value to pre-fill the input field.
+     */
+    defaultValue?: string;
+    /**
+     * The text for the "OK" button.
+     */
+    okButtonText?: string;
+    /**
+     * The placeholder text for the input field.
+     */
+    placeholder?: string;
+    /**
+     * The title of the modal.
+     */
+    title?: DocumentFragment | string;
+    /**
+     * A function to validate the input value.
+     * @param value - The input value to validate.
+     * @returns an error message if the value is invalid, or null if the value is valid.
+     */
+    valueValidator?: (value: string) => MaybePromise<string | void>;
+}
+/**
+ * Displays a prompt modal in Obsidian to get user input.
+ *
+ * @param options - The options for the prompt modal.
+ * @returns A promise that resolves with the user input or null if the prompt was cancelled.
+ */
+export declare function prompt(options: PromptOptions): Promise<null | string>;

package/dist/lib/esm/obsidian/Modals/SelectItem.d.mts

@@ -1 +1,41 @@
-export * from '../../../cjs/obsidian/Modals/SelectItem.cjs';
+/**
+ * @packageDocumentation selectItem
+ * Utility for displaying a selection modal in Obsidian.
+ *
+ * This module exports a function to display a modal that allows the user to select an item from a list. The modal uses fuzzy search to help the user find the item.
+ */
+import { App } from 'obsidian';
+/**
+ * The parameters for the selection modal.
+ */
+export interface SelectItemOptions<T> {
+    /**
+     * The Obsidian app instance.
+     */
+    app: App;
+    /**
+     * The CSS class to apply to the modal.
+     */
+    cssClass?: string;
+    /**
+     * The list of items to choose from.
+     */
+    items: T[];
+    /**
+     * A function to get the display text for each item
+     * @param item - The item to get the display text for.
+     * @returns The display text for the item.
+     */
+    itemTextFunc: (item: T) => string;
+    /**
+     * The placeholder text for the input field.
+     */
+    placeholder?: string;
+}
+/**
+ * Displays a selection modal in Obsidian for choosing an item from a list.
+ *
+ * @param options - The options for the selection modal.
+ * @returns A promise that resolves with the selected item or null if no item was selected.
+ */
+export declare function selectItem<T>(options: SelectItemOptions<T>): Promise<null | T>;

package/dist/lib/esm/obsidian/Modals/index.d.mts

@@ -1 +1,5 @@
-export * from '../../../cjs/obsidian/Modals/index.cjs';
+export * as Alert from './Alert.ts';
+export * as Confirm from './Confirm.ts';
+export * as ModalBase from './ModalBase.ts';
+export * as Prompt from './Prompt.ts';
+export * as SelectItem from './SelectItem.ts';

package/dist/lib/esm/obsidian/ObsidianSettings.d.mts

@@ -1 +1,17 @@
-export * from '../../cjs/obsidian/ObsidianSettings.cjs';
+/**
+ * @packageDocumentation
+ * This module provides utility functions for working with Obsidian settings.
+ */
+import type { App } from 'obsidian';
+/**
+ * Retrieves whether to use relative links based on the Obsidian settings.
+ * @param app - The Obsidian app instance.
+ * @returns Whether to use relative links.
+ */
+export declare function shouldUseRelativeLinks(app: App): boolean;
+/**
+ * Retrieves whether to use wikilinks based on the Obsidian settings.
+ * @param app - The Obsidian app instance.
+ * @returns Whether to use wikilinks.
+ */
+export declare function shouldUseWikilinks(app: App): boolean;

package/dist/lib/esm/obsidian/Pdf.d.mts

@@ -1 +1,24 @@
-export * from '../../cjs/obsidian/Pdf.cjs';
+/**
+ * @packageDocumentation Pdf
+ * Contains utility functions for printing to PDF.
+ */
+interface PrintToPdfOptions {
+    filepath: string;
+    includeName: boolean;
+    landscape: boolean;
+    marginsType: number;
+    open: boolean;
+    pageSize: string;
+    scale: number;
+    scaleFactor: number;
+}
+/**
+ * Print the given element to a PDF file.
+ *
+ * Works only on desktop.
+ *
+ * @param el - The element to print.
+ * @param options - The options to use for the print.
+ */
+export declare function printToPdf(el: HTMLElement, options: Partial<PrintToPdfOptions>): Promise<void>;
+export {};

package/dist/lib/esm/obsidian/Plugin/EmptySettings.d.mts

@@ -1 +1,14 @@
-export * from '../../../cjs/obsidian/Plugin/EmptySettings.cjs';
+/**
+ * @packageDocumentation EmptySettings
+ * Empty settings class.
+ */
+import type { PluginSettingsBase } from './PluginSettingsBase.d.mts';
+/**
+ * @packageDocumentation EmptySettings
+ * Empty settings class.
+ */
+/**
+ * Empty settings class.
+ */
+export declare class EmptySettings extends PluginSettingsBase {
+}

package/dist/lib/esm/obsidian/Plugin/ObsidianPluginRepoPaths.d.mts

@@ -1 +1,53 @@
-export * from '../../../cjs/obsidian/Plugin/ObsidianPluginRepoPaths.cjs';
+/**
+ * @packageDocumentation ObsidianPluginRepoPaths
+ * This file defines an enumeration for common file and directory paths used in Obsidian plugin development.
+ */
+/**
+ * Enumeration of commonly used file and directory paths in Obsidian plugin development.
+ */
+export declare enum ObsidianPluginRepoPaths {
+    /** Represents any path recursively. */
+    AnyPath = "**",
+    /** Represents any TypeScript file. */
+    AnyTs = "*.ts",
+    /** Represents the changelog file. */
+    ChangelogMd = "CHANGELOG.md",
+    /** Represents the current directory. */
+    CurrentDir = ".",
+    /** Represents the distribution directory. */
+    Dist = "dist",
+    /** Represents the build directory within the distribution directory. */
+    DistBuild = "dist/build",
+    /** Represents the development directory within the distribution directory. */
+    DistDev = "dist/dev",
+    /** Represents the ESLint configuration file. */
+    EslintConfigMjs = "eslint.config.mjs",
+    /** Represents the hot reload file. */
+    HotReload = ".hotreload",
+    /** Represents the lib directory. */
+    Lib = "lib",
+    /** Represents the main CSS file. */
+    MainCss = "main.css",
+    /** Represents the main JavaScript file. */
+    MainJs = "main.js",
+    /** Represents the main TypeScript file. */
+    MainTs = "main.ts",
+    /** Represents the manifest file for beta releases. */
+    ManifestBetaJson = "manifest-beta.json",
+    /** Represents the manifest file. */
+    ManifestJson = "manifest.json",
+    /** Represents the npm-shrinkwrap.json file. */
+    NpmShrinkwrapJson = "npm-shrinkwrap.json",
+    /** Represents the package.json file. */
+    PackageJson = "package.json",
+    /** Represents the package-lock.json file. */
+    PackageLockJson = "package-lock.json",
+    /** Represents the source directory. */
+    Src = "src",
+    /** Represents the styles.css file. */
+    StylesCss = "styles.css",
+    /** Represents the TypeScript configuration file. */
+    TsConfigJson = "tsconfig.json",
+    /** Represents the versions.json file. */
+    VersionsJson = "versions.json"
+}

package/dist/lib/esm/obsidian/Plugin/Plugin.d.mts

@@ -1 +1,21 @@
-export * from '../../../cjs/obsidian/Plugin/Plugin.cjs';
+/**
+ * @packageDocumentation Plugin
+ * This module provides utility functions for managing Obsidian plugins,
+ * including displaying error messages, disabling plugins, and reloading them.
+ */
+import { Plugin } from 'obsidian';
+/**
+ * Reloads the specified plugin by disabling and then re-enabling it.
+ *
+ * @param plugin - The plugin to reload.
+ * @returns A promise that resolves when the plugin is reloaded.
+ */
+export declare function reloadPlugin(plugin: Plugin): Promise<void>;
+/**
+ * Displays an error message as a notice, logs it to the console, and disables the specified plugin.
+ *
+ * @param plugin - The plugin to disable.
+ * @param message - The error message to display and log.
+ * @returns A promise that resolves when the plugin is disabled.
+ */
+export declare function showErrorAndDisablePlugin(plugin: Plugin, message: string): Promise<void>;

package/dist/lib/esm/obsidian/Plugin/PluginBase.d.mts

@@ -1 +1,108 @@
-export * from '../../../cjs/obsidian/Plugin/PluginBase.cjs';
+/**
+ * @packageDocumentation PluginBase
+ * Base class for Obsidian plugins providing utility methods for settings management, error handling, and notifications.
+ *
+ * This class simplifies the process of managing plugin settings, displaying notifications, and handling errors.
+ * Subclasses should implement methods to create default settings and settings tabs, and complete plugin-specific
+ * loading tasks.
+ */
+import type { ReadonlyDeep } from 'type-fest';
+import { Plugin, PluginSettingTab } from 'obsidian';
+import type { MaybePromise } from '../../Async.d.mts';
+import type { EmptySettings } from './EmptySettings.d.mts';
+import type { PluginSettingsBase } from './PluginSettingsBase.d.mts';
+/**
+ * Base class for creating Obsidian plugins with built-in support for settings management, error handling, and notifications.
+ *
+ * @typeParam PluginSettings - The type representing the plugin settings object.
+ */
+export declare abstract class PluginBase<PluginSettings extends PluginSettingsBase = EmptySettings> extends Plugin {
+    /**
+     * Gets the AbortSignal used for aborting long-running operations.
+     *
+     * @returns The abort signal.
+     */
+    get abortSignal(): AbortSignal;
+    /**
+     * Gets the readonly plugin settings.
+     *
+     * @returns The readonly plugin settings.
+     */
+    get settings(): ReadonlyDeep<PluginSettings>;
+    /**
+     * Gets a writable copy of the plugin settings.
+     *
+     * @returns A writable copy of the plugin settings.
+     */
+    get settingsClone(): PluginSettings;
+    private _abortSignal;
+    private _settings;
+    private notice?;
+    /**
+     * Logs a message to the console.
+     *
+     * Use instead of `console.debug()`.
+     *
+     * Those messages are not shown by default, but they can be shown by enabling `your-plugin-id` debugger namespace.
+     *
+     * @see {@link https://github.com/mnaoumov/obsidian-dev-utils/?tab=readme-ov-file#debugging} for more information.
+     *
+     * @param message - The message to log.
+     * @param args - The arguments to log.
+     */
+    consoleDebug(message: string, ...args: unknown[]): void;
+    /**
+     * Called when the external settings change.
+     */
+    onExternalSettingsChange(): Promise<void>;
+    /**
+     * Called when the plugin is loaded
+     */
+    onload(): Promise<void>;
+    /**
+     * Saves the new plugin settings.
+     *
+     * @param newSettings - The new settings to save.
+     * @returns A promise that resolves when the settings are saved.
+     */
+    saveSettings(newSettings: PluginSettings): Promise<void>;
+    /**
+     * Creates the plugin settings. This method must be implemented by subclasses.
+     *
+     * @param data - The data to create the plugin settings from.
+     * @returns The plugin settings.
+     */
+    protected abstract createPluginSettings(data: unknown): PluginSettings;
+    /**
+     * Creates a plugin settings tab. This method must be implemented by subclasses.
+     *
+     * @returns The settings tab or null if not applicable.
+     */
+    protected abstract createPluginSettingsTab(): null | PluginSettingTab;
+    /**
+     * Called when the layout is ready. This method can be overridden by subclasses to perform actions once
+     * the layout is ready.
+     *
+     * @returns A promise or void indicating the completion of the layout setup.
+     */
+    protected onLayoutReady(): MaybePromise<void>;
+    /**
+     * Called when the plugin loading is complete. This method must be implemented by subclasses to perform
+     * any additional setup required after loading is complete.
+     *
+     * @returns A promise or void indicating the completion of the load process.
+     */
+    protected onloadComplete(): MaybePromise<void>;
+    /**
+     * Displays a notice message to the user.
+     *
+     * @param message - The message to display.
+     */
+    protected showNotice(message: string): void;
+    /**
+     * Loads the plugin settings from the saved data.
+     *
+     * @returns A promise that resolves when the settings are loaded.
+     */
+    private loadSettings;
+}

package/dist/lib/esm/obsidian/Plugin/PluginContext.d.mts

@@ -1 +1,12 @@
-export * from '../../../cjs/obsidian/Plugin/PluginContext.cjs';
+/**
+ * @packageDocumentation PluginContext
+ * Initializes the plugin context and sets up the plugin ID.
+ */
+import type { App } from 'obsidian';
+/**
+ * Initializes the plugin context.
+ *
+ * @param app - The Obsidian app instance.
+ * @param pluginId - The plugin ID.
+ */
+export declare function initPluginContext(app: App, pluginId: string): void;

package/dist/lib/esm/obsidian/Plugin/PluginId.d.mts

@@ -1 +1,20 @@
-export * from '../../../cjs/obsidian/Plugin/PluginId.cjs';
+/**
+ * @packageDocumentation PluginId
+ * Holder for the plugin ID.
+ */
+/**
+ * The plugin ID for no plugin.
+ */
+export declare const NO_PLUGIN_ID_INITIALIZED = "__no-plugin-id-initialized__";
+/**
+ * Returns the plugin ID.
+ *
+ * @returns The plugin ID.
+ */
+export declare function getPluginId(): string;
+/**
+ * Sets the plugin ID.
+ *
+ * @param newPluginId - The new plugin ID.
+ */
+export declare function setPluginId(newPluginId: string): void;

package/dist/lib/esm/obsidian/Plugin/PluginSettingsBase.d.mts

@@ -1 +1,31 @@
-export * from '../../../cjs/obsidian/Plugin/PluginSettingsBase.cjs';
+/**
+ * @packageDocumentation PluginSettingsBase
+ * Base class for plugin settings.
+ */
+import type { Transformer } from '../../Transformers/Transformer.d.mts';
+/**
+ * Base class for plugin settings.
+ */
+export declare abstract class PluginSettingsBase {
+    /**
+     * Determines if the settings should be saved after loading.
+     *
+     * @returns A boolean indicating whether the settings should be saved after loading.
+     */
+    get shouldSaveAfterLoad(): boolean;
+    protected _shouldSaveAfterLoad: boolean;
+    /**
+     * Initializes the settings from JSON data.
+     *
+     * @param data - The data to initialize the settings from.
+     */
+    init(data: unknown): void;
+    /**
+     * Converts the settings to a JSON object.
+     *
+     * @returns The settings as a JSON object.
+     */
+    toJSON(): Record<string, unknown>;
+    protected getTransformer(): Transformer;
+    protected initFromRecord(record: Record<string, unknown>): void;
+}

package/dist/lib/esm/obsidian/Plugin/PluginSettingsTabBase.d.mts

@@ -1 +1,99 @@
-export * from '../../../cjs/obsidian/Plugin/PluginSettingsTabBase.cjs';
+/**
+ * @packageDocumentation PluginSettingsTabBase
+ * This module defines a base class for creating plugin setting tabs in Obsidian.
+ * It provides a utility method to bind value components to plugin settings and handle changes.
+ */
+import type { BaseComponent } from 'obsidian';
+import { PluginSettingTab } from 'obsidian';
+import type { MaybePromise } from '../../Async.d.mts';
+import type { KeysMatching } from '../../Object.d.mts';
+import type { ValueComponentWithChangeTracking } from '../Components/ValueComponentWithChangeTracking.d.mts';
+import type { PluginSettingsBase } from './PluginSettingsBase.d.mts';
+import type { PluginBase } from './PluginBase.d.mts';
+/**
+ * Options for binding a value component to a plugin setting.
+ */
+export interface BindOptions<PluginSettings, UIValue> {
+    /**
+     * A callback function that is called when the value of the component changes.
+     */
+    onChanged?: () => MaybePromise<void>;
+    /**
+     * The plugin settings object to bind the component to. Default is the plugin's current settings.
+     */
+    pluginSettings?: PluginSettings;
+    /**
+     * If true, saves the plugin settings automatically after the component value changes. Default is `true`.
+     */
+    shouldAutoSave?: boolean;
+    /**
+     * If true, shows the validation message when the component value is invalid. Default is `true`.
+     */
+    shouldShowValidationMessage?: boolean;
+    /**
+     * Validates the UI value before setting it on the plugin settings.
+     * @param uiValue - The value of the UI component.
+     * @returns An error message if the value is invalid, or `(empty string)` or `void` if it is valid.
+     */
+    valueValidator?: (uiValue: UIValue) => MaybePromise<string | void>;
+}
+/**
+ * Extended options for binding a value component to a plugin setting.
+ */
+export interface BindOptionsExtended<PluginSettings, UIValue, Property extends keyof PluginSettings> extends BindOptions<PluginSettings, UIValue> {
+    /**
+     * Converts the UI component's value back to the plugin settings value.
+     * @param uiValue - The value of the UI component.
+     * @returns The value to set on the plugin settings.
+     */
+    componentToPluginSettingsValueConverter: (uiValue: UIValue) => PluginSettings[Property];
+    /**
+     * Converts the plugin settings value to the value used by the UI component.
+     * @param pluginSettingsValue - The value of the property in the plugin settings.
+     * @returns The value to set on the UI component.
+     */
+    pluginSettingsToComponentValueConverter: (pluginSettingsValue: PluginSettings[Property]) => UIValue;
+}
+type ExtractPluginSettings<T extends PluginBase<any>> = PluginSettingsBase & T['settingsClone'];
+/**
+ * Base class for creating plugin settings tabs in Obsidian.
+ * Provides a method for binding value components to plugin settings and handling changes.
+ *
+ * @typeParam TPlugin - The type of the plugin that extends PluginBase.
+ */
+export declare abstract class PluginSettingsTabBase<TPlugin extends PluginBase<any>> extends PluginSettingTab {
+    plugin: TPlugin;
+    private validatorsMap;
+    constructor(plugin: TPlugin);
+    /**
+     * Binds a value component to a plugin setting.
+     *
+     * @typeParam UIValue - The type of the value of the UI component.
+     * @typeParam TValueComponent - The type of the value component.
+     * @param valueComponent - The value component to bind.
+     * @param property - The property of the plugin settings to bind to.
+     * @param options - The options for binding the value component.
+     * @returns The value component.
+     */
+    protected bind<UIValue, TValueComponent>(valueComponent: TValueComponent & ValueComponentWithChangeTracking<UIValue>, property: KeysMatching<ExtractPluginSettings<TPlugin>, UIValue>, options?: BindOptions<ExtractPluginSettings<TPlugin>, UIValue>): TValueComponent;
+    /**
+     * Binds a value component to a plugin setting.
+     *
+     * @typeParam UIValue - The type of the value of the UI component.
+     * @typeParam TValueComponent - The type of the value component.
+     * @typeParam Property - The property of the plugin settings to bind to.
+     * @param valueComponent - The value component to bind.
+     * @param property - The property of the plugin settings to bind to.
+     * @param options - The options for binding the value component.
+     * @returns The value component.
+     */
+    protected bind<UIValue, TValueComponent, Property extends keyof ExtractPluginSettings<TPlugin>>(valueComponent: TValueComponent & ValueComponentWithChangeTracking<UIValue>, property: Property, options: BindOptionsExtended<ExtractPluginSettings<TPlugin>, UIValue, Property>): TValueComponent;
+    /**
+     * Revalidates the value component.
+     *
+     * @param baseComponent - The base component to revalidate.
+     * @returns A promise that resolves to a boolean indicating whether the value component is valid.
+     */
+    protected revalidate(baseComponent: BaseComponent): Promise<boolean>;
+}
+export {};

package/dist/lib/esm/obsidian/Plugin/index.d.mts

@@ -1 +1,8 @@
-export * from '../../../cjs/obsidian/Plugin/index.cjs';
+export * as EmptySettings from './EmptySettings.ts';
+export * as ObsidianPluginRepoPaths from './ObsidianPluginRepoPaths.ts';
+export * as Plugin from './Plugin.ts';
+export * as PluginBase from './PluginBase.ts';
+export * as PluginContext from './PluginContext.ts';
+export * as PluginId from './PluginId.ts';
+export * as PluginSettingsBase from './PluginSettingsBase.ts';
+export * as PluginSettingsTabBase from './PluginSettingsTabBase.ts';

package/dist/lib/esm/obsidian/Queue.d.mts

@@ -1 +1,30 @@
-export * from '../../cjs/obsidian/Queue.cjs';
+/**
+ * @packageDocumentation Queue
+ * Contains utility functions for enqueuing and processing functions in Obsidian.
+ */
+import type { App } from 'obsidian';
+import type { MaybePromise } from '../Async.d.mts';
+/**
+ * Adds an asynchronous function to be executed after the previous function completes.
+ *
+ * @param app - The Obsidian application instance.
+ * @param fn - The function to add.
+ * @param timeoutInMilliseconds - The timeout in milliseconds.
+ * @param stackTrace - Optional stack trace.
+ */
+export declare function addToQueue(app: App, fn: () => MaybePromise<void>, timeoutInMilliseconds?: number, stackTrace?: string): void;
+/**
+ * Adds an asynchronous function to be executed after the previous function completes and returns a promise that resolves when the function completes.
+ *
+ * @param app - The Obsidian application instance.
+ * @param fn - The function to add.
+ * @param timeoutInMilliseconds - The timeout in milliseconds.
+ * @param stackTrace - Optional stack trace.
+ */
+export declare function addToQueueAndWait(app: App, fn: () => MaybePromise<void>, timeoutInMilliseconds?: number, stackTrace?: string): Promise<void>;
+/**
+ * Flushes the queue;
+ *
+ * @param app - The Obsidian application instance.
+ */
+export declare function flushQueue(app: App): Promise<void>;

package/dist/lib/esm/obsidian/Reference.d.mts

@@ -1 +1,21 @@
-export * from '../../cjs/obsidian/Reference.cjs';
+/**
+ * @packageDocumentation Reference
+ * Contains utility functions for handling references in Obsidian.
+ */
+import type { Reference } from 'obsidian';
+import type { FileChange } from './FileChange.d.mts';
+/**
+ * Converts a reference to a file change.
+ *
+ * @param reference - The reference to convert.
+ * @param newContent - The new content for the reference.
+ * @returns The file change.
+ */
+export declare function referenceToFileChange(reference: Reference, newContent: string): FileChange;
+/**
+ * Sorts references by their type and position.
+ *
+ * @param references - The references to sort.
+ * @returns The sorted references.
+ */
+export declare function sortReferences(references: Reference[]): Reference[];