obsidian-dev-utils 19.0.0 → 19.0.1

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

@@ -1,23 +1 @@
-/**
- * @packageDocumentation MarkdownCodeBlockProcessor
- * This module provides utility functions for processing code blocks in Obsidian.
- */
-import type { App, MarkdownPostProcessorContext } from 'obsidian';
-import type { ValueProvider } from '../ValueProvider.mjs';
-/**
- * Retrieves the argument of a code block from the given MarkdownPostProcessorContext and HTMLElement.
- *
- * @param ctx - The MarkdownPostProcessorContext object.
- * @param el - The HTMLElement representing the code block.
- * @returns The argument of the code block as a string, or null if no argument is found.
- */
-export declare function getCodeBlockArguments(ctx: MarkdownPostProcessorContext, el: HTMLElement): string[];
-/**
- * Replaces the code block.
- *
- * @param app - The Obsidian App object.
- * @param ctx - The MarkdownPostProcessorContext object.
- * @param el - The HTMLElement representing the code block.
- * @param codeBlockProvider - The ValueProvider that provides the new code block.
- */
-export declare function replaceCodeBlock(app: App, ctx: MarkdownPostProcessorContext, el: HTMLElement, codeBlockProvider: ValueProvider<string, [string]>): Promise<void>;
+export * from './MarkdownCodeBlockProcessor.cjs';

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

@@ -1,12 +1 @@
-/**
- * @packageDocumentation MarkdownView
- * Utilities for working with MarkdownView
- */
-import { MarkdownView } from 'obsidian';
-/**
- * Get the full HTML content of the current MarkdownView
- *
- * @param view - The MarkdownView to get the HTML from
- * @returns The full HTML of the MarkdownView
- */
-export declare function getFullContentHtml(view: MarkdownView): string;
+export * from './MarkdownView.cjs';

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

@@ -1,87 +1 @@
-/**
- * @packageDocumentation MetadataCache
- * This module provides utility functions for working with the metadata cache in Obsidian.
- */
-import type { App, CachedMetadata, Reference, TAbstractFile } from 'obsidian';
-import type { CustomArrayDict } from 'obsidian-typings';
-import type { RetryOptions } from '../Async.mjs';
-import type { PathOrFile } from './FileSystem.mjs';
-import type { CombinedFrontmatter } from './Frontmatter.mjs';
-/**
- * Wrapper for the getBacklinksForFile method that provides a safe overload.
- */
-export interface GetBacklinksForFileSafeWrapper {
-    /**
-     * Retrieves the backlinks for a file safely.
-     *
-     * @param pathOrFile - The path or file object.
-     * @returns A promise that resolves to an array dictionary of backlinks.
-     */
-    safe(pathOrFile: PathOrFile): Promise<CustomArrayDict<Reference>>;
-}
-/**
- * Ensures that the metadata cache is ready for all files.
- * @param app - The Obsidian app instance.
- * @returns A promise that resolves when the metadata cache is ready.
- */
-export declare function ensureMetadataCacheReady(app: App): Promise<void>;
-/**
- * Retrieves all links from the provided cache.
- *
- * @param cache - The cached metadata.
- * @returns An array of reference caches representing the links.
- */
-export declare function getAllLinks(cache: CachedMetadata): Reference[];
-/**
- * Retrieves the backlinks for a file or path.
- * NOTE: The file may be non-existent.
- *
- * @param app - The Obsidian application instance.
- * @param pathOrFile - The path or file object.
- * @returns The backlinks for the file.
- */
-export declare function getBacklinksForFileOrPath(app: App, pathOrFile: PathOrFile): CustomArrayDict<Reference>;
-/**
- * Retrieves the backlinks for a file safely.
- *
- * @param app - The Obsidian application instance.
- * @param pathOrFile - The path or file object.
- * @param retryOptions - Optional retry options.
- * @returns A promise that resolves to an array dictionary of backlinks.
- */
-export declare function getBacklinksForFileSafe(app: App, pathOrFile: PathOrFile, retryOptions?: RetryOptions): Promise<CustomArrayDict<Reference>>;
-/**
- * Retrieves the cached metadata for a given file or path.
- *
- * @param app - The Obsidian app instance.
- * @param fileOrPath - The file or path to retrieve the metadata for.
- * @param retryOptions - Optional retry options for the retrieval process.
- * @returns The cached metadata for the file, or null if it doesn't exist.
- */
-export declare function getCacheSafe(app: App, fileOrPath: PathOrFile, retryOptions?: RetryOptions): Promise<CachedMetadata | null>;
-/**
- * Retrieves the front matter from the metadata cache safely.
- *
- * @typeParam CustomFrontmatter - The type of custom front matter.
- * @param app - The Obsidian app instance.
- * @param pathOrFile - The path or file to retrieve the front matter from.
- * @returns The combined front matter.
- */
-export declare function getFrontmatterSafe<CustomFrontmatter = unknown>(app: App, pathOrFile: PathOrFile): Promise<CombinedFrontmatter<CustomFrontmatter>>;
-/***
- * Registers a file in the Obsidian app.
- *
- * @param app - The Obsidian app instance.
- * @param file - The file to register.
- * @returns A function that unregisters the file.
- */
-export declare function registerFile(app: App, file: TAbstractFile): () => void;
-/**
- * Temporarily registers a file and runs a function.
- *
- * @param app - The Obsidian app instance.
- * @param file - The file to temporarily register.
- * @param fn - The function to run.
- * @returns The result of the function.
- */
-export declare function tempRegisterFileAndRun<T>(app: App, file: TAbstractFile, fn: () => T): T;
+export * from './MetadataCache.cjs';

package/dist/lib/obsidian/Modals/Alert.d.mts

@@ -1,39 +1 @@
-/**
- * @packageDocumentation Alert
- * Utility for displaying alert modals in Obsidian.
- *
- * This module exports a function to display a modal with a message in Obsidian. The modal includes an "OK" button to close it.
- */
-import type { App } from 'obsidian';
-/**
- * The options for the alert modal.
- */
-export interface AlertOptions {
-    /**
-     * The Obsidian app instance.
-     */
-    app: App;
-    /**
-     * 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 alert modal in Obsidian with a specified message.
- *
- * @param options - The options for the alert modal.
- * @returns A promise that resolves when the modal is closed.
- */
-export declare function alert(options: AlertOptions): Promise<void>;
+export * from './Alert.cjs';

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

@@ -1,43 +1 @@
-/**
- * @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>;
+export * from './Confirm.cjs';

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

@@ -1,35 +1 @@
-/**
- * @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.mjs';
-/**
- * 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>;
+export * from './ModalBase.cjs';

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

@@ -1,50 +1 @@
-/**
- * @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 { App } from 'obsidian';
-import type { MaybePromise } from '../../Async.mjs';
-/**
- * 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>;
+export * from './Prompt.cjs';

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

@@ -1,41 +1 @@
-/**
- * @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>;
+export * from './SelectItem.cjs';

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

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

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

@@ -1,17 +1 @@
-/**
- * @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;
+export * from './ObsidianSettings.cjs';

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

@@ -1,24 +1 @@
-/**
- * @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 {};
+export * from './Pdf.cjs';

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

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

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

@@ -1,55 +1 @@
-/**
- * @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 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 Library.cjs file. */
-    LibraryCjs = "Library.cjs",
-    /** Represents the Library.mjs file. */
-    LibraryMjs = "Library.mjs",
-    /** 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"
-}
+export * from './ObsidianPluginRepoPaths.cjs';

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

@@ -1,21 +1 @@
-/**
- * @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>;
+export * from './Plugin.cjs';

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

@@ -1,108 +1 @@
-/**
- * @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.mjs';
-import type { EmptySettings } from './EmptySettings.mjs';
-import type { PluginSettingsBase } from './PluginSettingsBase.mjs';
-/**
- * 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;
-}
+export * from './PluginBase.cjs';

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

@@ -1,12 +1 @@
-/**
- * @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;
+export * from './PluginContext.cjs';

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

@@ -1,20 +1 @@
-/**
- * @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;
+export * from './PluginId.cjs';

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

@@ -1,31 +1 @@
-/**
- * @packageDocumentation PluginSettingsBase
- * Base class for plugin settings.
- */
-import { Transformer } from '../../Transformers/Transformer.mjs';
-/**
- * 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;
-}
+export * from './PluginSettingsBase.cjs';