obsidian-dev-utils 80.1.0 → 82.0.0-beta.0

package/dist/lib/esm/obsidian/vault-delete.d.mts

@@ -5,15 +5,20 @@
  * This module provides deletion utilities that require metadata cache access.
  */
 import type { App } from 'obsidian';
+import type { PluginNoticeComponent } from './components/plugin-notice-component.mjs';
 import type { PathOrAbstractFile } from './file-system.mjs';
+interface DeleteIfNotUsedParams {
+    readonly app: App;
+    readonly deletedNotePath?: string;
+    readonly pathOrFile: PathOrAbstractFile;
+    readonly pluginNoticeComponent?: PluginNoticeComponent;
+    readonly shouldDeleteEmptyFolders?: boolean;
+}
 /**
  * Deletes an abstract file safely from the vault, but only if it is not referenced by other notes.
  *
- * @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.
+ * @param params - The parameters for the function.
  * @returns A {@link Promise} that resolves to a boolean indicating whether the removal was successful.
  */
-export declare function deleteIfNotUsed(app: App, pathOrFile: PathOrAbstractFile, deletedNotePath?: string, shouldReportUsedAttachments?: boolean, shouldDeleteEmptyFolders?: boolean): Promise<boolean>;
+export declare function deleteIfNotUsed(params: DeleteIfNotUsedParams): Promise<boolean>;
+export {};

package/dist/lib/esm/obsidian/vault-delete.mjs

@@ -21,8 +21,8 @@ if you want to view the source, please visit the github repository of this plugi
   globalThis.process = browserProcess;
 })();
 
-import { Notice } from "obsidian";
 import { printError } from "../error.mjs";
+import { normalizeOptionalProperties } from "../object-utils.mjs";
 import {
   getAbstractFileOrNull,
   isFile,
@@ -35,33 +35,37 @@ import {
   listSafe,
   trashSafe
 } from "./vault.mjs";
-async function deleteIfNotUsed(app, pathOrFile, deletedNotePath, shouldReportUsedAttachments, shouldDeleteEmptyFolders) {
-  const file = getAbstractFileOrNull(app, pathOrFile);
+async function deleteIfNotUsed(params) {
+  const file = getAbstractFileOrNull({ app: params.app, pathOrFile: params.pathOrFile });
   if (!file) {
     return false;
   }
-  let canDelete = isFile(file) || (shouldDeleteEmptyFolders ?? true);
+  let canDelete = isFile(file) || (params.shouldDeleteEmptyFolders ?? true);
   if (isFile(file)) {
-    const backlinks = await getBacklinksForFileSafe(app, file);
-    if (deletedNotePath) {
-      backlinks.clear(deletedNotePath);
+    const backlinks = await getBacklinksForFileSafe({ app: params.app, pathOrFile: file });
+    if (params.deletedNotePath) {
+      backlinks.clear(params.deletedNotePath);
     }
     if (backlinks.count() !== 0) {
-      if (shouldReportUsedAttachments) {
-        new Notice(t(($) => $.obsidianDevUtils.notices.attachmentIsStillUsed, { attachmentPath: file.path }));
-      }
+      params.pluginNoticeComponent?.showNotice(t(($) => $.obsidianDevUtils.notices.attachmentIsStillUsed, { attachmentPath: file.path }));
       canDelete = false;
     }
   } else if (isFolder(file)) {
-    const listedFiles = await listSafe(app, file);
+    const listedFiles = await listSafe(params.app, file);
     for (const child of [...listedFiles.files, ...listedFiles.folders]) {
-      canDelete &&= await deleteIfNotUsed(app, child, deletedNotePath, shouldReportUsedAttachments);
+      canDelete &&= await deleteIfNotUsed(normalizeOptionalProperties({
+        app: params.app,
+        deletedNotePath: params.deletedNotePath,
+        pathOrFile: child,
+        pluginNoticeComponent: params.pluginNoticeComponent,
+        shouldDeleteEmptyFolders: params.shouldDeleteEmptyFolders
+      }));
     }
-    canDelete &&= await isEmptyFolder(app, file);
+    canDelete &&= await isEmptyFolder(params.app, file);
   }
   if (canDelete) {
     try {
-      await trashSafe(app, file);
+      await trashSafe(params.app, file);
     } catch (e) {
       printError(new Error(`Failed to delete ${file.path}`, { cause: e }));
       canDelete = false;
@@ -72,4 +76,4 @@ async function deleteIfNotUsed(app, pathOrFile, deletedNotePath, shouldReportUse
 export {
   deleteIfNotUsed
 };
-//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL3ZhdWx0LWRlbGV0ZS50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIFRoaXMgbW9kdWxlIHByb3ZpZGVzIGRlbGV0aW9uIHV0aWxpdGllcyB0aGF0IHJlcXVpcmUgbWV0YWRhdGEgY2FjaGUgYWNjZXNzLlxuICovXG5cbmltcG9ydCB0eXBlIHsgQXBwIH0gZnJvbSAnb2JzaWRpYW4nO1xuXG5pbXBvcnQgeyBOb3RpY2UgfSBmcm9tICdvYnNpZGlhbic7XG5cbmltcG9ydCB0eXBlIHsgUGF0aE9yQWJzdHJhY3RGaWxlIH0gZnJvbSAnLi9maWxlLXN5c3RlbS50cyc7XG5cbmltcG9ydCB7IHByaW50RXJyb3IgfSBmcm9tICcuLi9lcnJvci50cyc7XG5pbXBvcnQge1xuICBnZXRBYnN0cmFjdEZpbGVPck51bGwsXG4gIGlzRmlsZSxcbiAgaXNGb2xkZXJcbn0gZnJvbSAnLi9maWxlLXN5c3RlbS50cyc7XG5pbXBvcnQgeyB0IH0gZnJvbSAnLi9pMThuL2kxOG4udHMnO1xuaW1wb3J0IHsgZ2V0QmFja2xpbmtzRm9yRmlsZVNhZmUgfSBmcm9tICcuL21ldGFkYXRhLWNhY2hlLnRzJztcbmltcG9ydCB7XG4gIGlzRW1wdHlGb2xkZXIsXG4gIGxpc3RTYWZlLFxuICB0cmFzaFNhZmVcbn0gZnJvbSAnLi92YXVsdC50cyc7XG5cbi8qKlxuICogRGVsZXRlcyBhbiBhYnN0cmFjdCBmaWxlIHNhZmVseSBmcm9tIHRoZSB2YXVsdCwgYnV0IG9ubHkgaWYgaXQgaXMgbm90IHJlZmVyZW5jZWQgYnkgb3RoZXIgbm90ZXMuXG4gKlxuICogQHBhcmFtIGFwcCAtIFRoZSBPYnNpZGlhbiBhcHBsaWNhdGlvbiBpbnN0YW5jZS5cbiAqIEBwYXJhbSBwYXRoT3JGaWxlIC0gVGhlIHBhdGggb3IgYWJzdHJhY3QgZmlsZSB0byBkZWxldGUuXG4gKiBAcGFyYW0gZGVsZXRlZE5vdGVQYXRoIC0gT3B0aW9uYWwuIFRoZSBwYXRoIG9mIHRoZSBub3RlIHRoYXQgdHJpZ2dlcmVkIHRoZSByZW1vdmFsLlxuICogQHBhcmFtIHNob3VsZFJlcG9ydFVzZWRBdHRhY2htZW50cyAtIE9wdGlvbmFsLiBJZiBgdHJ1ZWAsIGEgbm90aWNlIHdpbGwgYmUgc2hvd24gZm9yIGVhY2ggYXR0YWNobWVudCB0aGF0IGlzIHN0aWxsIHVzZWQgYnkgb3RoZXIgbm90ZXMuXG4gKiBAcGFyYW0gc2hvdWxkRGVsZXRlRW1wdHlGb2xkZXJzIC0gT3B0aW9uYWwuIElmIGB0cnVlYCwgZW1wdHkgZm9sZGVycyB3aWxsIGJlIGRlbGV0ZWQuXG4gKiBAcmV0dXJucyBBIHtAbGluayBQcm9taXNlfSB0aGF0IHJlc29sdmVzIHRvIGEgYm9vbGVhbiBpbmRpY2F0aW5nIHdoZXRoZXIgdGhlIHJlbW92YWwgd2FzIHN1Y2Nlc3NmdWwuXG4gKi9cbmV4cG9ydCBhc3luYyBmdW5jdGlvbiBkZWxldGVJZk5vdFVzZWQoXG4gIGFwcDogQXBwLFxuICBwYXRoT3JGaWxlOiBQYXRoT3JBYnN0cmFjdEZpbGUsXG4gIGRlbGV0ZWROb3RlUGF0aD86IHN0cmluZyxcbiAgc2hvdWxkUmVwb3J0VXNlZEF0dGFjaG1lbnRzPzogYm9vbGVhbixcbiAgc2hvdWxkRGVsZXRlRW1wdHlGb2xkZXJzPzogYm9vbGVhblxuKTogUHJvbWlzZTxib29sZWFuPiB7XG4gIGNvbnN0IGZpbGUgPSBnZXRBYnN0cmFjdEZpbGVPck51bGwoYXBwLCBwYXRoT3JGaWxlKTtcblxuICBpZiAoIWZpbGUpIHtcbiAgICByZXR1cm4gZmFsc2U7XG4gIH1cblxuICBsZXQgY2FuRGVsZXRlID0gaXNGaWxlKGZpbGUpIHx8IChzaG91bGREZWxldGVFbXB0eUZvbGRlcnMgPz8gdHJ1ZSk7XG5cbiAgLyogdjggaWdub3JlIHN0YXJ0IC0tIFRBYnN0cmFjdEZpbGUgaXMgYWx3YXlzIFRGaWxlIG9yIFRGb2xkZXIgaW4gT2JzaWRpYW47IHRoZSBmYWxzZSBicmFuY2ggb2YgaXNGaWxlIGxlYWRzIHRvIGlzRm9sZGVyLiAqL1xuICBpZiAoaXNGaWxlKGZpbGUpKSB7XG4gICAgLyogdjggaWdub3JlIHN0b3AgKi9cbiAgICBjb25zdCBiYWNrbGlua3MgPSBhd2FpdCBnZXRCYWNrbGlua3NGb3JGaWxlU2FmZShhcHAsIGZpbGUpO1xuICAgIGlmIChkZWxldGVkTm90ZVBhdGgpIHtcbiAgICAgIGJhY2tsaW5rcy5jbGVhcihkZWxldGVkTm90ZVBhdGgpO1xuICAgIH1cbiAgICBpZiAoYmFja2xpbmtzLmNvdW50KCkgIT09IDApIHtcbiAgICAgIGlmIChzaG91bGRSZXBvcnRVc2VkQXR0YWNobWVudHMpIHtcbiAgICAgICAgbmV3IE5vdGljZSh0KCgkKSA9PiAkLm9ic2lkaWFuRGV2VXRpbHMubm90aWNlcy5hdHRhY2htZW50SXNTdGlsbFVzZWQsIHsgYXR0YWNobWVudFBhdGg6IGZpbGUucGF0aCB9KSk7XG4gICAgICB9XG4gICAgICBjYW5EZWxldGUgPSBmYWxzZTtcbiAgICB9XG4gICAgLyogdjggaWdub3JlIHN0YXJ0IC0tIFRBYnN0cmFjdEZpbGUgaXMgYWx3YXlzIFRGaWxlIG9yIFRGb2xkZXIgaW4gT2JzaWRpYW47IGRlZmVuc2l2ZSBmYWxsYmFjay4gKi9cbiAgfSBlbHNlIGlmIChpc0ZvbGRlcihmaWxlKSkge1xuICAgIC8qIHY4IGlnbm9yZSBzdG9wICovXG4gICAgY29uc3QgbGlzdGVkRmlsZXMgPSBhd2FpdCBsaXN0U2FmZShhcHAsIGZpbGUpO1xuICAgIGZvciAoY29uc3QgY2hpbGQgb2YgWy4uLmxpc3RlZEZpbGVzLmZpbGVzLCAuLi5saXN0ZWRGaWxlcy5mb2xkZXJzXSkge1xuICAgICAgY2FuRGVsZXRlICYmPSBhd2FpdCBkZWxldGVJZk5vdFVzZWQoYXBwLCBjaGlsZCwgZGVsZXRlZE5vdGVQYXRoLCBzaG91bGRSZXBvcnRVc2VkQXR0YWNobWVudHMpO1xuICAgIH1cblxuICAgIGNhbkRlbGV0ZSAmJj0gYXdhaXQgaXNFbXB0eUZvbGRlcihhcHAsIGZpbGUpO1xuICB9XG5cbiAgaWYgKGNhbkRlbGV0ZSkge1xuICAgIHRyeSB7XG4gICAgICBhd2FpdCB0cmFzaFNhZmUoYXBwLCBmaWxlKTtcbiAgICB9IGNhdGNoIChlKSB7XG4gICAgICBwcmludEVycm9yKG5ldyBFcnJvcihgRmFpbGVkIHRvIGRlbGV0ZSAke2ZpbGUucGF0aH1gLCB7IGNhdXNlOiBlIH0pKTtcbiAgICAgIGNhbkRlbGV0ZSA9IGZhbHNlO1xuICAgIH1cbiAgfVxuXG4gIHJldHVybiBjYW5EZWxldGU7XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQVFBLFNBQVMsY0FBYztBQUl2QixTQUFTLGtCQUFrQjtBQUMzQjtBQUFBLEVBQ0U7QUFBQSxFQUNBO0FBQUEsRUFDQTtBQUFBLE9BQ0s7QUFDUCxTQUFTLFNBQVM7QUFDbEIsU0FBUywrQkFBK0I7QUFDeEM7QUFBQSxFQUNFO0FBQUEsRUFDQTtBQUFBLEVBQ0E7QUFBQSxPQUNLO0FBWVAsZUFBc0IsZ0JBQ3BCLEtBQ0EsWUFDQSxpQkFDQSw2QkFDQSwwQkFDa0I7QUFDbEIsUUFBTSxPQUFPLHNCQUFzQixLQUFLLFVBQVU7QUFFbEQsTUFBSSxDQUFDLE1BQU07QUFDVCxXQUFPO0FBQUEsRUFDVDtBQUVBLE1BQUksWUFBWSxPQUFPLElBQUksTUFBTSw0QkFBNEI7QUFHN0QsTUFBSSxPQUFPLElBQUksR0FBRztBQUVoQixVQUFNLFlBQVksTUFBTSx3QkFBd0IsS0FBSyxJQUFJO0FBQ3pELFFBQUksaUJBQWlCO0FBQ25CLGdCQUFVLE1BQU0sZUFBZTtBQUFBLElBQ2pDO0FBQ0EsUUFBSSxVQUFVLE1BQU0sTUFBTSxHQUFHO0FBQzNCLFVBQUksNkJBQTZCO0FBQy9CLFlBQUksT0FBTyxFQUFFLENBQUMsTUFBTSxFQUFFLGlCQUFpQixRQUFRLHVCQUF1QixFQUFFLGdCQUFnQixLQUFLLEtBQUssQ0FBQyxDQUFDO0FBQUEsTUFDdEc7QUFDQSxrQkFBWTtBQUFBLElBQ2Q7QUFBQSxFQUVGLFdBQVcsU0FBUyxJQUFJLEdBQUc7QUFFekIsVUFBTSxjQUFjLE1BQU0sU0FBUyxLQUFLLElBQUk7QUFDNUMsZUFBVyxTQUFTLENBQUMsR0FBRyxZQUFZLE9BQU8sR0FBRyxZQUFZLE9BQU8sR0FBRztBQUNsRSxvQkFBYyxNQUFNLGdCQUFnQixLQUFLLE9BQU8saUJBQWlCLDJCQUEyQjtBQUFBLElBQzlGO0FBRUEsa0JBQWMsTUFBTSxjQUFjLEtBQUssSUFBSTtBQUFBLEVBQzdDO0FBRUEsTUFBSSxXQUFXO0FBQ2IsUUFBSTtBQUNGLFlBQU0sVUFBVSxLQUFLLElBQUk7QUFBQSxJQUMzQixTQUFTLEdBQUc7QUFDVixpQkFBVyxJQUFJLE1BQU0sb0JBQW9CLEtBQUssSUFBSSxJQUFJLEVBQUUsT0FBTyxFQUFFLENBQUMsQ0FBQztBQUNuRSxrQkFBWTtBQUFBLElBQ2Q7QUFBQSxFQUNGO0FBRUEsU0FBTztBQUNUOyIsCiAgIm5hbWVzIjogW10KfQo=
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL3ZhdWx0LWRlbGV0ZS50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIFRoaXMgbW9kdWxlIHByb3ZpZGVzIGRlbGV0aW9uIHV0aWxpdGllcyB0aGF0IHJlcXVpcmUgbWV0YWRhdGEgY2FjaGUgYWNjZXNzLlxuICovXG5cbmltcG9ydCB0eXBlIHsgQXBwIH0gZnJvbSAnb2JzaWRpYW4nO1xuXG5pbXBvcnQgdHlwZSB7IFBsdWdpbk5vdGljZUNvbXBvbmVudCB9IGZyb20gJy4vY29tcG9uZW50cy9wbHVnaW4tbm90aWNlLWNvbXBvbmVudC50cyc7XG5pbXBvcnQgdHlwZSB7IFBhdGhPckFic3RyYWN0RmlsZSB9IGZyb20gJy4vZmlsZS1zeXN0ZW0udHMnO1xuXG5pbXBvcnQgeyBwcmludEVycm9yIH0gZnJvbSAnLi4vZXJyb3IudHMnO1xuaW1wb3J0IHsgbm9ybWFsaXplT3B0aW9uYWxQcm9wZXJ0aWVzIH0gZnJvbSAnLi4vb2JqZWN0LXV0aWxzLnRzJztcbmltcG9ydCB7XG4gIGdldEFic3RyYWN0RmlsZU9yTnVsbCxcbiAgaXNGaWxlLFxuICBpc0ZvbGRlclxufSBmcm9tICcuL2ZpbGUtc3lzdGVtLnRzJztcbmltcG9ydCB7IHQgfSBmcm9tICcuL2kxOG4vaTE4bi50cyc7XG5pbXBvcnQgeyBnZXRCYWNrbGlua3NGb3JGaWxlU2FmZSB9IGZyb20gJy4vbWV0YWRhdGEtY2FjaGUudHMnO1xuaW1wb3J0IHtcbiAgaXNFbXB0eUZvbGRlcixcbiAgbGlzdFNhZmUsXG4gIHRyYXNoU2FmZVxufSBmcm9tICcuL3ZhdWx0LnRzJztcblxuaW50ZXJmYWNlIERlbGV0ZUlmTm90VXNlZFBhcmFtcyB7XG4gIHJlYWRvbmx5IGFwcDogQXBwO1xuICByZWFkb25seSBkZWxldGVkTm90ZVBhdGg/OiBzdHJpbmc7XG4gIHJlYWRvbmx5IHBhdGhPckZpbGU6IFBhdGhPckFic3RyYWN0RmlsZTtcbiAgcmVhZG9ubHkgcGx1Z2luTm90aWNlQ29tcG9uZW50PzogUGx1Z2luTm90aWNlQ29tcG9uZW50O1xuICByZWFkb25seSBzaG91bGREZWxldGVFbXB0eUZvbGRlcnM/OiBib29sZWFuO1xufVxuXG4vKipcbiAqIERlbGV0ZXMgYW4gYWJzdHJhY3QgZmlsZSBzYWZlbHkgZnJvbSB0aGUgdmF1bHQsIGJ1dCBvbmx5IGlmIGl0IGlzIG5vdCByZWZlcmVuY2VkIGJ5IG90aGVyIG5vdGVzLlxuICpcbiAqIEBwYXJhbSBwYXJhbXMgLSBUaGUgcGFyYW1ldGVycyBmb3IgdGhlIGZ1bmN0aW9uLlxuICogQHJldHVybnMgQSB7QGxpbmsgUHJvbWlzZX0gdGhhdCByZXNvbHZlcyB0byBhIGJvb2xlYW4gaW5kaWNhdGluZyB3aGV0aGVyIHRoZSByZW1vdmFsIHdhcyBzdWNjZXNzZnVsLlxuICovXG5leHBvcnQgYXN5bmMgZnVuY3Rpb24gZGVsZXRlSWZOb3RVc2VkKHBhcmFtczogRGVsZXRlSWZOb3RVc2VkUGFyYW1zKTogUHJvbWlzZTxib29sZWFuPiB7XG4gIGNvbnN0IGZpbGUgPSBnZXRBYnN0cmFjdEZpbGVPck51bGwoeyBhcHA6IHBhcmFtcy5hcHAsIHBhdGhPckZpbGU6IHBhcmFtcy5wYXRoT3JGaWxlIH0pO1xuXG4gIGlmICghZmlsZSkge1xuICAgIHJldHVybiBmYWxzZTtcbiAgfVxuXG4gIGxldCBjYW5EZWxldGUgPSBpc0ZpbGUoZmlsZSkgfHwgKHBhcmFtcy5zaG91bGREZWxldGVFbXB0eUZvbGRlcnMgPz8gdHJ1ZSk7XG5cbiAgLyogdjggaWdub3JlIHN0YXJ0IC0tIFRBYnN0cmFjdEZpbGUgaXMgYWx3YXlzIFRGaWxlIG9yIFRGb2xkZXIgaW4gT2JzaWRpYW47IHRoZSBmYWxzZSBicmFuY2ggb2YgaXNGaWxlIGxlYWRzIHRvIGlzRm9sZGVyLiAqL1xuICBpZiAoaXNGaWxlKGZpbGUpKSB7XG4gICAgLyogdjggaWdub3JlIHN0b3AgKi9cbiAgICBjb25zdCBiYWNrbGlua3MgPSBhd2FpdCBnZXRCYWNrbGlua3NGb3JGaWxlU2FmZSh7IGFwcDogcGFyYW1zLmFwcCwgcGF0aE9yRmlsZTogZmlsZSB9KTtcbiAgICBpZiAocGFyYW1zLmRlbGV0ZWROb3RlUGF0aCkge1xuICAgICAgYmFja2xpbmtzLmNsZWFyKHBhcmFtcy5kZWxldGVkTm90ZVBhdGgpO1xuICAgIH1cbiAgICBpZiAoYmFja2xpbmtzLmNvdW50KCkgIT09IDApIHtcbiAgICAgIHBhcmFtcy5wbHVnaW5Ob3RpY2VDb21wb25lbnQ/LnNob3dOb3RpY2UodCgoJCkgPT4gJC5vYnNpZGlhbkRldlV0aWxzLm5vdGljZXMuYXR0YWNobWVudElzU3RpbGxVc2VkLCB7IGF0dGFjaG1lbnRQYXRoOiBmaWxlLnBhdGggfSkpO1xuICAgICAgY2FuRGVsZXRlID0gZmFsc2U7XG4gICAgfVxuICAgIC8qIHY4IGlnbm9yZSBzdGFydCAtLSBUQWJzdHJhY3RGaWxlIGlzIGFsd2F5cyBURmlsZSBvciBURm9sZGVyIGluIE9ic2lkaWFuOyBkZWZlbnNpdmUgZmFsbGJhY2suICovXG4gIH0gZWxzZSBpZiAoaXNGb2xkZXIoZmlsZSkpIHtcbiAgICAvKiB2OCBpZ25vcmUgc3RvcCAqL1xuICAgIGNvbnN0IGxpc3RlZEZpbGVzID0gYXdhaXQgbGlzdFNhZmUocGFyYW1zLmFwcCwgZmlsZSk7XG4gICAgZm9yIChjb25zdCBjaGlsZCBvZiBbLi4ubGlzdGVkRmlsZXMuZmlsZXMsIC4uLmxpc3RlZEZpbGVzLmZvbGRlcnNdKSB7XG4gICAgICBjYW5EZWxldGUgJiY9IGF3YWl0IGRlbGV0ZUlmTm90VXNlZChub3JtYWxpemVPcHRpb25hbFByb3BlcnRpZXM8RGVsZXRlSWZOb3RVc2VkUGFyYW1zPih7XG4gICAgICAgIGFwcDogcGFyYW1zLmFwcCxcbiAgICAgICAgZGVsZXRlZE5vdGVQYXRoOiBwYXJhbXMuZGVsZXRlZE5vdGVQYXRoLFxuICAgICAgICBwYXRoT3JGaWxlOiBjaGlsZCxcbiAgICAgICAgcGx1Z2luTm90aWNlQ29tcG9uZW50OiBwYXJhbXMucGx1Z2luTm90aWNlQ29tcG9uZW50LFxuICAgICAgICBzaG91bGREZWxldGVFbXB0eUZvbGRlcnM6IHBhcmFtcy5zaG91bGREZWxldGVFbXB0eUZvbGRlcnNcbiAgICAgIH0pKTtcbiAgICB9XG5cbiAgICBjYW5EZWxldGUgJiY9IGF3YWl0IGlzRW1wdHlGb2xkZXIocGFyYW1zLmFwcCwgZmlsZSk7XG4gIH1cblxuICBpZiAoY2FuRGVsZXRlKSB7XG4gICAgdHJ5IHtcbiAgICAgIGF3YWl0IHRyYXNoU2FmZShwYXJhbXMuYXBwLCBmaWxlKTtcbiAgICB9IGNhdGNoIChlKSB7XG4gICAgICBwcmludEVycm9yKG5ldyBFcnJvcihgRmFpbGVkIHRvIGRlbGV0ZSAke2ZpbGUucGF0aH1gLCB7IGNhdXNlOiBlIH0pKTtcbiAgICAgIGNhbkRlbGV0ZSA9IGZhbHNlO1xuICAgIH1cbiAgfVxuXG4gIHJldHVybiBjYW5EZWxldGU7XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQVdBLFNBQVMsa0JBQWtCO0FBQzNCLFNBQVMsbUNBQW1DO0FBQzVDO0FBQUEsRUFDRTtBQUFBLEVBQ0E7QUFBQSxFQUNBO0FBQUEsT0FDSztBQUNQLFNBQVMsU0FBUztBQUNsQixTQUFTLCtCQUErQjtBQUN4QztBQUFBLEVBQ0U7QUFBQSxFQUNBO0FBQUEsRUFDQTtBQUFBLE9BQ0s7QUFnQlAsZUFBc0IsZ0JBQWdCLFFBQWlEO0FBQ3JGLFFBQU0sT0FBTyxzQkFBc0IsRUFBRSxLQUFLLE9BQU8sS0FBSyxZQUFZLE9BQU8sV0FBVyxDQUFDO0FBRXJGLE1BQUksQ0FBQyxNQUFNO0FBQ1QsV0FBTztBQUFBLEVBQ1Q7QUFFQSxNQUFJLFlBQVksT0FBTyxJQUFJLE1BQU0sT0FBTyw0QkFBNEI7QUFHcEUsTUFBSSxPQUFPLElBQUksR0FBRztBQUVoQixVQUFNLFlBQVksTUFBTSx3QkFBd0IsRUFBRSxLQUFLLE9BQU8sS0FBSyxZQUFZLEtBQUssQ0FBQztBQUNyRixRQUFJLE9BQU8saUJBQWlCO0FBQzFCLGdCQUFVLE1BQU0sT0FBTyxlQUFlO0FBQUEsSUFDeEM7QUFDQSxRQUFJLFVBQVUsTUFBTSxNQUFNLEdBQUc7QUFDM0IsYUFBTyx1QkFBdUIsV0FBVyxFQUFFLENBQUMsTUFBTSxFQUFFLGlCQUFpQixRQUFRLHVCQUF1QixFQUFFLGdCQUFnQixLQUFLLEtBQUssQ0FBQyxDQUFDO0FBQ2xJLGtCQUFZO0FBQUEsSUFDZDtBQUFBLEVBRUYsV0FBVyxTQUFTLElBQUksR0FBRztBQUV6QixVQUFNLGNBQWMsTUFBTSxTQUFTLE9BQU8sS0FBSyxJQUFJO0FBQ25ELGVBQVcsU0FBUyxDQUFDLEdBQUcsWUFBWSxPQUFPLEdBQUcsWUFBWSxPQUFPLEdBQUc7QUFDbEUsb0JBQWMsTUFBTSxnQkFBZ0IsNEJBQW1EO0FBQUEsUUFDckYsS0FBSyxPQUFPO0FBQUEsUUFDWixpQkFBaUIsT0FBTztBQUFBLFFBQ3hCLFlBQVk7QUFBQSxRQUNaLHVCQUF1QixPQUFPO0FBQUEsUUFDOUIsMEJBQTBCLE9BQU87QUFBQSxNQUNuQyxDQUFDLENBQUM7QUFBQSxJQUNKO0FBRUEsa0JBQWMsTUFBTSxjQUFjLE9BQU8sS0FBSyxJQUFJO0FBQUEsRUFDcEQ7QUFFQSxNQUFJLFdBQVc7QUFDYixRQUFJO0FBQ0YsWUFBTSxVQUFVLE9BQU8sS0FBSyxJQUFJO0FBQUEsSUFDbEMsU0FBUyxHQUFHO0FBQ1YsaUJBQVcsSUFBSSxNQUFNLG9CQUFvQixLQUFLLElBQUksSUFBSSxFQUFFLE9BQU8sRUFBRSxDQUFDLENBQUM7QUFDbkUsa0JBQVk7QUFBQSxJQUNkO0FBQUEsRUFDRjtBQUVBLFNBQU87QUFDVDsiLAogICJuYW1lcyI6IFtdCn0K

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

@@ -16,32 +16,193 @@ import { FileSystemType } from './file-system.mjs';
 export interface ContentArgs {
     readonly content: string;
 }
+/**
+ * Parameters for {@link copySafe}.
+ */
+export interface CopySafeParams {
+    /**
+     * The application instance.
+     */
+    readonly app: App;
+    /**
+     * The new path to copy the file to.
+     */
+    readonly newPath: string;
+    /**
+     * The old path or file to copy.
+     */
+    readonly oldPathOrFile: PathOrFile;
+}
+/**
+ * Parameters for {@link getAbstractFilePathSafe}.
+ */
+export interface GetAbstractFilePathSafeParams {
+    /**
+     * The application instance.
+     */
+    readonly app: App;
+    /**
+     * The path of the file or folder to get a safe path for.
+     */
+    readonly path: string;
+    /**
+     * The type of the file system object.
+     */
+    readonly type: FileSystemType;
+}
+/**
+ * Parameters for {@link getOrCreateAbstractFileSafe}.
+ */
+export interface GetOrCreateAbstractFileSafeParams {
+    /**
+     * The application instance.
+     */
+    readonly app: App;
+    /**
+     * The path of the abstract file to get or create.
+     */
+    readonly path: string;
+    /**
+     * The type of the abstract file to get or create.
+     */
+    readonly type: FileSystemType;
+}
+/**
+ * Parameters for {@link getSafeRenamePath}.
+ */
+export interface GetSafeRenamePathParams {
+    /**
+     * The application instance.
+     */
+    readonly app: App;
+    /**
+     * The new path to rename the abstract file to.
+     */
+    readonly newPath: string;
+    /**
+     * The old path or abstract file to rename.
+     */
+    readonly oldPathOrAbstractFile: PathOrAbstractFile;
+}
+/**
+ * Parameters for {@link invokeWithFileSystemLock}.
+ */
+export interface InvokeWithFileSystemLockParams {
+    /**
+     * The application instance.
+     */
+    readonly app: App;
+    /**
+     * The function to execute.
+     *
+     * @param content - The content of the file.
+     */
+    fn(this: void, content: string): void;
+    /**
+     * The path or file to execute the function with the file system lock of.
+     */
+    readonly pathOrFile: PathOrFile;
+}
+/**
+ * Parameters for {@link isChildOrSelf}.
+ */
+export interface IsChildOrSelfParams {
+    /**
+     * The application instance.
+     */
+    readonly app: App;
+    /**
+     * The path or file to check whether it is a child or self.
+     */
+    readonly childPathOrFile: PathOrAbstractFile;
+    /**
+     * The path or file to check whether it is a parent or self.
+     */
+    readonly parentPathOrFile: PathOrAbstractFile;
+}
+/**
+ * Parameters for {@link isChild}.
+ */
+export interface IsChildParams {
+    /**
+     * The application instance.
+     */
+    readonly app: App;
+    /**
+     * The path or file to check whether it is a child.
+     */
+    readonly childPathOrFile: PathOrAbstractFile;
+    /**
+     * The path or file to check whether it is a parent.
+     */
+    readonly parentPathOrFile: PathOrAbstractFile;
+}
 /**
  * Options for {@link process}.
  */
 export interface ProcessOptions extends RetryOptions {
     /**
-     * Whether to fail if the file is missing or deleted. Default is `true`.
+     * Whether to fail if the file is missing or deleted.
+     *
+     * @default `true`
      */
     readonly shouldFailOnMissingFile?: boolean;
     /**
-     * Whether to lock the editor while processing the file. Applicable only for markdown files. Default is `true`.
+     * Whether to lock the editor while processing the file. Applicable only for markdown files.
+     *
+     * @default `true`
      */
     readonly shouldLockEditorWhileProcessing?: boolean;
     /**
-     * Whether to show a timeout notice. Default is `true`.
+     * Whether to show a timeout notice.
+     *
+     * @default `true`
      */
     readonly shouldShowTimeoutNotice?: boolean;
 }
+/**
+ * Parameters for {@link process}.
+ */
+export interface ProcessParams extends ProcessOptions {
+    /**
+     * The application instance, typically used for accessing the vault.
+     */
+    readonly app: App;
+    /**
+     * 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.
+     */
+    readonly newContentProvider: ValueProvider<null | string, ContentArgs>;
+    /**
+     * The path or file to be processed. It can be a string representing the path or a file object.
+     */
+    readonly pathOrFile: PathOrFile;
+}
+/**
+ * Parameters for {@link renameSafe}.
+ */
+export interface RenameSafeParams {
+    /**
+     * The application instance.
+     */
+    readonly app: App;
+    /**
+     * The new path to rename the file to.
+     */
+    readonly newPath: string;
+    /**
+     * The old path or abstract file to rename.
+     */
+    readonly oldPathOrAbstractFile: PathOrAbstractFile;
+}
 /**
  * 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.
+ * @param params - The parameters for copying the file.
  * @returns A {@link Promise} that resolves to the new path of the copied file.
  */
-export declare function copySafe(app: App, oldPathOrFile: PathOrFile, newPath: string): Promise<string>;
+export declare function copySafe(params: CopySafeParams): Promise<string>;
 /**
  * Creates a folder safely in the specified path.
  *
@@ -86,12 +247,10 @@ export declare function deleteEmptyFolderHierarchy(app: App, pathOrFolder: null
 /**
  * Gets a safe path for a file or folder.
  *
- * @param app - The application instance.
- * @param path - The path of the file or folder to get a safe path for.
- * @param type - The type of the file system object.
+ * @param params - The parameters for getting a safe path.
  * @returns The safe path for the file or folder.
  */
-export declare function getAbstractFilePathSafe(app: App, path: string, type: FileSystemType): string;
+export declare function getAbstractFilePathSafe(params: GetAbstractFilePathSafeParams): string;
 /**
  * Gets an available path for a file in the vault.
  *
@@ -136,12 +295,10 @@ export declare function getNoteFilesSorted(app: App): TFile[];
  * If the file already exists, it will be returned.
  * If the file does not exist, it will be created and returned.
  *
- * @param app - The application instance.
- * @param path - The path of the abstract file to get or create.
- * @param type - The type of the abstract file to get or create.
+ * @param params - The parameters for getting or creating the abstract file.
  * @returns A {@link Promise} that resolves to the abstract file.
  */
-export declare function getOrCreateAbstractFileSafe(app: App, path: string, type: FileSystemType): Promise<TAbstractFile>;
+export declare function getOrCreateAbstractFileSafe(params: GetOrCreateAbstractFileSafeParams): Promise<TAbstractFile>;
 /**
  * Gets or creates a file safely in the specified path.
  *
@@ -167,38 +324,31 @@ export declare function getOrCreateFolderSafe(app: App, path: string): Promise<T
 /**
  * Gets a safe rename path for a file.
  *
- * @param app - The application instance.
- * @param oldPathOrAbstractFile - The old path or abstract file to rename.
- * @param newPath - The new path to rename the abstract file to.
+ * @param params - The parameters for getting a safe rename path.
  * @returns The safe rename path for the abstract file.
  */
-export declare function getSafeRenamePath(app: App, oldPathOrAbstractFile: PathOrAbstractFile, newPath: string): string;
+export declare function getSafeRenamePath(params: GetSafeRenamePathParams): string;
 /**
  * Invokes a function with the file system lock.
  *
- * @param app - The application instance.
- * @param pathOrFile - The path or file to execute the function with the file system lock of.
- * @param fn - The function to execute.
+ * @param params - The parameters for invoking the function with the file system lock.
+ * @returns A {@link Promise} that resolves when the function is invoked.
  */
-export declare function invokeWithFileSystemLock(app: App, pathOrFile: PathOrFile, fn: (content: string) => void): Promise<void>;
+export declare function invokeWithFileSystemLock(params: InvokeWithFileSystemLockParams): Promise<void>;
 /**
  * Checks if a path or file is a child of another path or file.
  *
- * @param app - The application instance.
- * @param a - The first path or file.
- * @param b - The second path or file.
- * @returns A boolean indicating whether the first path or file is a child of the second path or file.
+ * @param params - The parameters for checking whether the child path or file is a child of the parent path or file.
+ * @returns A boolean indicating whether the child path or file is a child of the parent path or file.
  */
-export declare function isChild(app: App, a: PathOrAbstractFile, b: PathOrAbstractFile): boolean;
+export declare function isChild(params: IsChildParams): boolean;
 /**
  * Checks if a path or file is a child or self of another path or file.
  *
- * @param app - The application instance.
- * @param a - The first path or file.
- * @param b - The second path or file.
- * @returns A boolean indicating whether the first path or file is a child or self of the second path or file.
+ * @param params - The parameters for checking whether the child path or file is a child or self of the parent path or file.
+ * @returns A boolean indicating whether the child path or file is a child or self of the parent path or file.
  */
-export declare function isChildOrSelf(app: App, a: PathOrAbstractFile, b: PathOrAbstractFile): boolean;
+export declare function isChildOrSelf(params: IsChildOrSelfParams): boolean;
 /**
  * Checks if a folder is empty.
  *
@@ -218,18 +368,13 @@ export declare function listSafe(app: App, pathOrFolder: PathOrFolder): Promise<
 /**
  * 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.
+ * @param params - The parameters for processing the file.
  *
  * @returns A {@link 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, ContentArgs>, options?: ProcessOptions): Promise<void>;
+export declare function process(params: ProcessParams): Promise<void>;
 /**
  * Reads the content of a file safely from the vault.
  *
@@ -244,12 +389,10 @@ export declare function readSafe(app: App, pathOrFile: PathOrFile): Promise<null
  * 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 oldPathOrAbstractFile - The old path or file to rename.
- * @param newPath - The new path to rename the file to.
+ * @param params - The parameters for renaming the file.
  * @returns A {@link Promise} that resolves to the new path of the file.
  */
-export declare function renameSafe(app: App, oldPathOrAbstractFile: PathOrAbstractFile, newPath: string): Promise<string>;
+export declare function renameSafe(params: RenameSafeParams): Promise<string>;
 /**
  * Saves the specified note in the Obsidian app.
  *