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

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

@@ -1 +1,49 @@
-export * from '../../cjs/obsidian/RenameDeleteHandler.cjs';
+/**
+ * @packageDocumentation RenameDeleteHandler
+ * Contains utility functions for handling rename and delete events in Obsidian.
+ */
+import type { Plugin } from 'obsidian';
+/**
+ * Settings for the rename/delete handler.
+ */
+export interface RenameDeleteHandlerSettings {
+    /**
+     * Whether to ignore the path.
+     */
+    isPathIgnored(path: string): boolean;
+    /**
+     * Whether to delete conflicting attachments.
+     */
+    shouldDeleteConflictingAttachments: boolean;
+    /**
+     * Whether to delete empty folders.
+     */
+    shouldDeleteEmptyFolders: boolean;
+    /**
+     * Whether to handle deletions.
+     */
+    shouldHandleDeletions: boolean;
+    /**
+     * Whether to handle renames.
+     */
+    shouldHandleRenames: boolean;
+    /**
+     * Whether to rename attachment files when a note is renamed.
+     */
+    shouldRenameAttachmentFiles: boolean;
+    /**
+     * Whether to rename attachment folder when a note is renamed.
+     */
+    shouldRenameAttachmentFolder: boolean;
+    /**
+     * Whether to update filename aliases when a note is renamed.
+     */
+    shouldUpdateFilenameAliases: boolean;
+}
+/**
+ * Registers the rename/delete handlers.
+ * @param plugin - The plugin instance.
+ * @param settingsBuilder - A function that returns the settings for the rename delete handler.
+ * @returns void
+ */
+export declare function registerRenameDeleteHandlers(plugin: Plugin, settingsBuilder: () => Partial<RenameDeleteHandlerSettings>): void;

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

@@ -1 +1,14 @@
-export * from '../../cjs/obsidian/ResourceUrl.cjs';
+/**
+ * @packageDocumentation ResourceUrl
+ * This module provides utility functions for working with resource URLs in Obsidian.
+ */
+import type { App } from 'obsidian';
+/**
+ * Converts a relative path to a resource URL.
+ *
+ * @param app - The Obsidian application instance.
+ * @param relativePath - The relative path to the resource.
+ * @param notePath - The path of the note.
+ * @returns The resource URL.
+ */
+export declare function relativePathToResourceUrl(app: App, relativePath: string, notePath: string): string;

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

@@ -1 +1,124 @@
-export * from '../../cjs/obsidian/SettingEx.cjs';
+/**
+ * @packageDocumentation SettingEx
+ * Extends the Setting class with additional methods for adding components.
+ */
+import type { BaseComponent } from 'obsidian';
+import { Setting } from 'obsidian';
+import { DateComponent } from './Components/DateComponent.d.mts';
+import { DateTimeComponent } from './Components/DateTimeComponent.d.mts';
+import { EmailComponent } from './Components/EmailComponent.d.mts';
+import { FileComponent } from './Components/FileComponent.d.mts';
+import { MonthComponent } from './Components/MonthComponent.d.mts';
+import { MultipleDropdownComponent } from './Components/MultipleDropdownComponent.d.mts';
+import { MultipleEmailComponent } from './Components/MultipleEmailComponent.d.mts';
+import { MultipleFileComponent } from './Components/MultipleFileComponent.d.mts';
+import { MultipleTextComponent } from './Components/MultipleTextComponent.d.mts';
+import { NumberComponent } from './Components/NumberComponent.d.mts';
+import { TimeComponent } from './Components/TimeComponent.d.mts';
+import { UrlComponent } from './Components/UrlComponent.d.mts';
+import { WeekComponent } from './Components/WeekComponent.d.mts';
+/**
+ * Extends the Setting class with additional methods for adding components.
+ */
+export declare class SettingEx extends Setting {
+    /**
+     * Adds a component to the setting.
+     *
+     * @typeParam T - The type of the component to add.
+     * @param componentClass - The class of the component to add.
+     * @param cb - The callback to call with the component.
+     * @returns The setting instance.
+     */
+    addComponent<T extends BaseComponent>(componentClass: new (controlEl: HTMLElement) => T, cb: (component: T) => void): this;
+    /**
+     * Adds a {@link DateComponent} to the setting.
+     *
+     * @param cb - The callback to call with the component.
+     * @returns The setting instance.
+     */
+    addDate(cb: (component: DateComponent) => void): this;
+    /**
+     * Adds a {@link DateTimeComponent} to the setting.
+     *
+     * @param cb - The callback to call with the component.
+     * @returns The setting instance.
+     */
+    addDateTime(cb: (component: DateTimeComponent) => void): this;
+    /**
+     * Adds an {@link EmailComponent} to the setting.
+     *
+     * @param cb - The callback to call with the component.
+     * @returns The setting instance.
+     */
+    addEmail(cb: (component: EmailComponent) => void): this;
+    /**
+     * Adds a {@link FileComponent} to the setting.
+     *
+     * @param cb - The callback to call with the component.
+     * @returns The setting instance.
+     */
+    addFile(cb: (component: FileComponent) => void): this;
+    /**
+     * Adds a {@link MonthComponent} to the setting.
+     *
+     * @param cb - The callback to call with the component.
+     * @returns The setting instance.
+     */
+    addMonth(cb: (component: MonthComponent) => void): this;
+    /**
+     * Adds a {@link MultipleDropdownComponent} to the setting.
+     *
+     * @param cb - The callback to call with the component.
+     * @returns The setting instance.
+     */
+    addMultipleDropdown(cb: (component: MultipleDropdownComponent) => void): this;
+    /**
+     * Adds a {@link MultipleEmailComponent} to the setting.
+     *
+     * @param cb - The callback to call with the component.
+     * @returns The setting instance.
+     */
+    addMultipleEmail(cb: (component: MultipleEmailComponent) => void): this;
+    /**
+     * Adds a {@link MultipleFileComponent} to the setting.
+     *
+     * @param cb - The callback to call with the component.
+     * @returns The setting instance.
+     */
+    addMultipleFile(cb: (component: MultipleFileComponent) => void): this;
+    /**
+     * Adds a {@link MultipleTextComponent} to the setting.
+     *
+     * @param cb - The callback to call with the component.
+     * @returns The setting instance.
+     */
+    addMultipleText(cb: (component: MultipleTextComponent) => void): this;
+    /**
+     * Adds a {@link NumberComponent} to the setting.
+     *
+     * @param cb - The callback to call with the component.
+     * @returns The setting instance.
+     */
+    addNumber(cb: (component: NumberComponent) => void): this;
+    /**
+     * Adds a {@link TimeComponent} to the setting.
+     *
+     * @param cb - The callback to call with the component.
+     * @returns The setting instance.
+     */
+    addTime(cb: (component: TimeComponent) => void): this;
+    /**
+     * Adds an {@link UrlComponent} to the setting.
+     *
+     * @param cb - The callback to call with the component.
+     * @returns The setting instance.
+     */
+    addUrl(cb: (component: UrlComponent) => void): this;
+    /**
+     * Adds a {@link WeekComponent} to the setting.
+     *
+     * @param cb - The callback to call with the component.
+     * @returns The setting instance.
+     */
+    addWeek(cb: (component: WeekComponent) => void): this;
+}

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

@@ -1 +1,130 @@
-export * from '../../cjs/obsidian/Vault.cjs';
+/**
+ * @packageDocumentation Vault
+ * This module provides utility functions for working with the Obsidian Vault.
+ */
+import type { ListedFiles } from 'obsidian';
+import { App, TFile } from 'obsidian';
+import type { RetryOptions } from '../Async.d.mts';
+import type { ValueProvider } from '../ValueProvider.d.mts';
+import type { PathOrFile, PathOrFolder } from './FileSystem.d.mts';
+/**
+ * Options for the `process` function.
+ */
+export interface ProcessOptions extends RetryOptions {
+    /**
+     * If `true`, the function will throw an error if the file is missing or deleted.
+     */
+    shouldFailOnMissingFile?: boolean;
+}
+/**
+ * Copies a file safely in the vault.
+ *
+ * @param app - The application instance.
+ * @param oldPathOrFile - The old path or file to copy.
+ * @param newPath - The new path to copy the file to.
+ * @returns A promise that resolves to the new path of the copied file.
+ */
+export declare function copySafe(app: App, oldPathOrFile: PathOrFile, newPath: string): Promise<string>;
+/**
+ * Creates a folder safely in the specified path.
+ *
+ * @param app - The application instance.
+ * @param path - The path of the folder to create.
+ * @returns A promise that resolves to a boolean indicating whether the folder was created.
+ * @throws If an error occurs while creating the folder and it still doesn't exist.
+ */
+export declare function createFolderSafe(app: App, path: string): Promise<boolean>;
+/**
+ * Creates a temporary file in the vault with parent folders if needed.
+ * @param app - The application instance.
+ * @param path - The path of the file to create.
+ * @returns A promise that resolves to a function that can be called to delete the temporary file and all its created parents.
+ */
+export declare function createTempFile(app: App, path: string): Promise<() => Promise<void>>;
+/**
+ * Creates a temporary folder in the vault with parent folders if needed.
+ * @param app - The application instance.
+ * @param path - The path of the folder to create.
+ * @returns A promise that resolves to a function that can be called to delete the temporary folder and all its created parents.
+ */
+export declare function createTempFolder(app: App, path: string): Promise<() => Promise<void>>;
+/**
+ * Gets an available path for a file in the vault.
+ *
+ * @param app - The application instance.
+ * @param path - The path of the file to get an available path for.
+ * @returns The available path for the file.
+ */
+export declare function getAvailablePath(app: App, path: string): string;
+/**
+ * Retrieves an array of Markdown files from the app's vault and sorts them alphabetically by their file path.
+ *
+ * @param app - The Obsidian app instance.
+ * @returns An array of Markdown files sorted by file path.
+ */
+export declare function getMarkdownFilesSorted(app: App): TFile[];
+/**
+ * Retrieves an array of all note files from the app's vault and sorts them alphabetically by their file path.
+ * @param app - The Obsidian app instance.
+ * @returns An array of all note files in the vault sorted by file path.
+ */
+export declare function getNoteFilesSorted(app: App): TFile[];
+/**
+ * Gets a safe rename path for a file.
+ *
+ * @param app - The application instance.
+ * @param oldPathOrFile - The old path or file to rename.
+ * @param newPath - The new path to rename the file to.
+ * @returns The safe rename path for the file.
+ */
+export declare function getSafeRenamePath(app: App, oldPathOrFile: PathOrFile, newPath: string): string;
+/**
+ * Checks if a folder is empty.
+ * @param app - The application instance.
+ * @param pathOrFolder - The path or folder to check.
+ * @returns A promise that resolves to a boolean indicating whether the folder is empty.
+ */
+export declare function isEmptyFolder(app: App, pathOrFolder: PathOrFolder): Promise<boolean>;
+/**
+ * Safely lists the files and folders at the specified path in the vault.
+ *
+ * @param app - The Obsidian application instance.
+ * @param pathOrFolder - The path or folder to list.
+ * @returns A promise that resolves to a `ListedFiles` object containing the listed files and folders.
+ */
+export declare function listSafe(app: App, pathOrFolder: PathOrFolder): Promise<ListedFiles>;
+/**
+ * Processes a file with retry logic, updating its content based on a provided value or function.
+ *
+ * @param app - The application instance, typically used for accessing the vault.
+ * @param pathOrFile - The path or file to be processed. It can be a string representing the path or a file object.
+ * @param newContentProvider - A value provider that returns the new content based on the old content of the file.
+ * It can be a string or a function that takes the old content as an argument and returns the new content.
+ * If function is provided, it should return `null` if the process should be retried.
+ * @param options - Optional options for processing/retrying the operation.
+ *
+ * @returns A promise that resolves once the process is complete.
+ *
+ * @throws Will throw an error if the process fails after the specified number of retries or timeout.
+ */
+export declare function process(app: App, pathOrFile: PathOrFile, newContentProvider: ValueProvider<null | string, [string]>, options?: ProcessOptions): Promise<void>;
+/**
+ * Reads the content of a file safely from the vault.
+ *
+ * It covers the case when the file was removed during the reading.
+ *
+ * @param app - The application instance.
+ * @param pathOrFile - The path or file to read.
+ * @returns A promise that resolves to the content of the file or `null` if the file is missing or deleted.
+ */
+export declare function readSafe(app: App, pathOrFile: PathOrFile): Promise<null | string>;
+/**
+ * Renames a file safely in the vault.
+ * If the new path already exists, the file will be renamed to an available path.
+ *
+ * @param app - The application instance.
+ * @param oldPathOrFile - The old path or file to rename.
+ * @param newPath - The new path to rename the file to.
+ * @returns A promise that resolves to the new path of the file.
+ */
+export declare function renameSafe(app: App, oldPathOrFile: PathOrFile, newPath: string): Promise<string>;

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

@@ -1 +1,27 @@
-export * from '../../cjs/obsidian/VaultEx.cjs';
+/**
+ * @packageDocumentation VaultEx
+ * This module provides additional utilities for working with the Obsidian Vault.
+ *
+ * It has to be extracted from `Vault` because of circular dependencies.
+ */
+import type { App } from 'obsidian';
+import type { PathOrAbstractFile, PathOrFolder } from './FileSystem.d.mts';
+/**
+ * Removes empty folder hierarchy starting from the given folder.
+ *
+ * @param app - The application instance.
+ * @param pathOrFolder - The folder to start removing empty hierarchy from.
+ * @returns A promise that resolves when the empty hierarchy is deleted.
+ */
+export declare function deleteEmptyFolderHierarchy(app: App, pathOrFolder: null | PathOrFolder): Promise<void>;
+/**
+ * Deletes abstract file safely from the vault.
+ *
+ * @param app - The Obsidian application instance.
+ * @param pathOrFile - The path or abstract file to delete.
+ * @param deletedNotePath - Optional. The path of the note that triggered the removal.
+ * @param shouldReportUsedAttachments - Optional. If `true`, a notice will be shown for each attachment that is still used by other notes.
+ * @param shouldDeleteEmptyFolders - Optional. If `true`, empty folders will be deleted.
+ * @returns A promise that resolves to a boolean indicating whether the removal was successful.
+ */
+export declare function deleteSafe(app: App, pathOrFile: PathOrAbstractFile, deletedNotePath?: string, shouldReportUsedAttachments?: boolean, shouldDeleteEmptyFolders?: boolean): Promise<boolean>;

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

@@ -1 +1,29 @@
-export * from '../../cjs/obsidian/index.cjs';
+export * as App from './App.d.mts';
+export * as AttachmentPath from './AttachmentPath.d.mts';
+export * as Backlink from './Backlink.d.mts';
+export * as Callout from './Callout.d.mts';
+export * as Components from './Components/index.d.mts';
+export * as Dataview from './Dataview.d.mts';
+export * as DataviewLink from './DataviewLink.d.mts';
+export * as FileChange from './FileChange.d.mts';
+export * as FileManager from './FileManager.d.mts';
+export * as FileSystem from './FileSystem.d.mts';
+export * as Frontmatter from './Frontmatter.d.mts';
+export * as Link from './Link.d.mts';
+export * as Logger from './Logger.d.mts';
+export * as Loop from './Loop.d.mts';
+export * as Markdown from './Markdown.d.mts';
+export * as MarkdownCodeBlockProcessor from './MarkdownCodeBlockProcessor.d.mts';
+export * as MarkdownView from './MarkdownView.d.mts';
+export * as MetadataCache from './MetadataCache.d.mts';
+export * as Modals from './Modals/index.d.mts';
+export * as ObsidianSettings from './ObsidianSettings.d.mts';
+export * as Pdf from './Pdf.d.mts';
+export * as Plugin from './Plugin/index.d.mts';
+export * as Queue from './Queue.d.mts';
+export * as Reference from './Reference.d.mts';
+export * as RenameDeleteHandler from './RenameDeleteHandler.d.mts';
+export * as ResourceUrl from './ResourceUrl.d.mts';
+export * as SettingEx from './SettingEx.d.mts';
+export * as Vault from './Vault.d.mts';
+export * as VaultEx from './VaultEx.d.mts';

package/dist/lib/esm/url.d.mts

@@ -1 +1,11 @@
-export * from '../cjs/url.cjs';
+/**
+ * @packageDocumentation url
+ * Contains a utility function for validating URLs.
+ */
+/**
+ * Determines whether a given string is a valid URL
+ *
+ * @param str - The string to validate as a URL.
+ * @returns `true` if the string is a valid URL, otherwise `false`.
+ */
+export declare function isUrl(str: string): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-dev-utils",
-  "version": "19.1.2-beta.2",
+  "version": "19.1.2-beta.3",
   "description": "This is the collection of useful functions that you can use for your Obsidian plugin development",
   "keywords": [
     "obsidian"