obsidian-dev-utils 18.4.0 → 19.0.0

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

@@ -0,0 +1,108 @@
+/**
+ * @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;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * @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/obsidian/Plugin/PluginId.d.mts

@@ -0,0 +1,20 @@
+/**
+ * @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/obsidian/Plugin/{PluginSettingsBase.d.ts → PluginSettingsBase.d.cts}

@@ -2,7 +2,7 @@
  * @packageDocumentation PluginSettingsBase
  * Base class for plugin settings.
  */
-import { Transformer } from '../../Transformers/Transformer.ts';
+import { Transformer } from '../../Transformers/Transformer.cjs';
 /**
  * Base class for plugin settings.
  */

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

@@ -0,0 +1,31 @@
+/**
+ * @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;
+}

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

@@ -5,11 +5,11 @@
  */
 import type { BaseComponent } from 'obsidian';
 import { PluginSettingTab } from 'obsidian';
-import type { MaybePromise } from '../../Async.ts';
-import type { KeysMatching } from '../../Object.ts';
-import type { ValueComponentWithChangeTracking } from '../Components/ValueComponentWithChangeTracking.ts';
-import type { PluginSettingsBase } from './PluginSettingsBase.ts';
-import { PluginBase } from './PluginBase.ts';
+import type { MaybePromise } from '../../Async.cjs';
+import type { KeysMatching } from '../../Object.cjs';
+import type { ValueComponentWithChangeTracking } from '../Components/ValueComponentWithChangeTracking.cjs';
+import type { PluginSettingsBase } from './PluginSettingsBase.cjs';
+import { PluginBase } from './PluginBase.cjs';
 /**
  * Options for binding a value component to a plugin setting.
  */

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

@@ -0,0 +1,99 @@
+/**
+ * @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.mjs';
+import type { KeysMatching } from '../../Object.mjs';
+import type { ValueComponentWithChangeTracking } from '../Components/ValueComponentWithChangeTracking.mjs';
+import type { PluginSettingsBase } from './PluginSettingsBase.mjs';
+import { PluginBase } from './PluginBase.mjs';
+/**
+ * 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/obsidian/Plugin/index.cjs

@@ -0,0 +1,67 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function initCjs(){const globalThisRecord=globalThis;globalThisRecord["__name"]??=name;const originalRequire=require;if(originalRequire&&!originalRequire.__isPatched){require=Object.assign(id=>requirePatched(id),originalRequire,{__isPatched:true})}const newFuncs={__extractDefault:__name(()=>extractDefault,"__extractDefault"),process:__name(()=>{const browserProcess={browser:true,cwd:__name(()=>"/","cwd"),env:{},platform:"android"};return browserProcess},"process")};for(const key of Object.keys(newFuncs)){globalThisRecord[key]??=newFuncs[key]?.()}function name(obj){return obj}__name(name,"name");function extractDefault(module){return module&&module.__esModule&&module.default?module.default:module}__name(extractDefault,"extractDefault");function requirePatched(id){const module=originalRequire?.(id);if(module){return extractDefault(module)}if(id==="process"||id==="node:process"){console.error(`Module not found: ${id}. Fake process object is returned instead.`);return globalThis.process}console.error(`Module not found: ${id}. Empty object is returned instead.`);return{}}__name(requirePatched,"requirePatched")})();
+
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var Plugin_exports = {};
+__export(Plugin_exports, {
+  EmptySettings: () => EmptySettings,
+  ObsidianPluginRepoPaths: () => ObsidianPluginRepoPaths,
+  Plugin: () => Plugin,
+  PluginBase: () => PluginBase,
+  PluginContext: () => PluginContext,
+  PluginId: () => PluginId,
+  PluginSettingsBase: () => PluginSettingsBase,
+  PluginSettingsTabBase: () => PluginSettingsTabBase
+});
+module.exports = __toCommonJS(Plugin_exports);
+var EmptySettings = __toESM(__extractDefault(require('./EmptySettings.cjs')), 1);
+var ObsidianPluginRepoPaths = __toESM(__extractDefault(require('./ObsidianPluginRepoPaths.cjs')), 1);
+var Plugin = __toESM(__extractDefault(require('./Plugin.cjs')), 1);
+var PluginBase = __toESM(__extractDefault(require('./PluginBase.cjs')), 1);
+var PluginContext = __toESM(__extractDefault(require('./PluginContext.cjs')), 1);
+var PluginId = __toESM(__extractDefault(require('./PluginId.cjs')), 1);
+var PluginSettingsBase = __toESM(__extractDefault(require('./PluginSettingsBase.cjs')), 1);
+var PluginSettingsTabBase = __toESM(__extractDefault(require('./PluginSettingsTabBase.cjs')), 1);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  EmptySettings,
+  ObsidianPluginRepoPaths,
+  Plugin,
+  PluginBase,
+  PluginContext,
+  PluginId,
+  PluginSettingsBase,
+  PluginSettingsTabBase
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL1BsdWdpbi9pbmRleC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyogVEhJUyBJUyBBIEdFTkVSQVRFRC9CVU5ETEVEIEZJTEUgQlkgQlVJTEQgU0NSSVBUICovXG5cbmV4cG9ydCAqIGFzIEVtcHR5U2V0dGluZ3MgZnJvbSAnLi9FbXB0eVNldHRpbmdzLnRzJztcbmV4cG9ydCAqIGFzIE9ic2lkaWFuUGx1Z2luUmVwb1BhdGhzIGZyb20gJy4vT2JzaWRpYW5QbHVnaW5SZXBvUGF0aHMudHMnO1xuZXhwb3J0ICogYXMgUGx1Z2luIGZyb20gJy4vUGx1Z2luLnRzJztcbmV4cG9ydCAqIGFzIFBsdWdpbkJhc2UgZnJvbSAnLi9QbHVnaW5CYXNlLnRzJztcbmV4cG9ydCAqIGFzIFBsdWdpbkNvbnRleHQgZnJvbSAnLi9QbHVnaW5Db250ZXh0LnRzJztcbmV4cG9ydCAqIGFzIFBsdWdpbklkIGZyb20gJy4vUGx1Z2luSWQudHMnO1xuZXhwb3J0ICogYXMgUGx1Z2luU2V0dGluZ3NCYXNlIGZyb20gJy4vUGx1Z2luU2V0dGluZ3NCYXNlLnRzJztcbmV4cG9ydCAqIGFzIFBsdWdpblNldHRpbmdzVGFiQmFzZSBmcm9tICcuL1BsdWdpblNldHRpbmdzVGFiQmFzZS50cyc7XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUVBLG9CQUErQjtBQUMvQiw4QkFBeUM7QUFDekMsYUFBd0I7QUFDeEIsaUJBQTRCO0FBQzVCLG9CQUErQjtBQUMvQixlQUEwQjtBQUMxQix5QkFBb0M7QUFDcEMsNEJBQXVDOyIsCiAgIm5hbWVzIjogW10KfQo=

package/dist/lib/obsidian/Plugin/index.d.cts

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

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

@@ -0,0 +1,8 @@
+export * as EmptySettings from './EmptySettings.mjs';
+export * as ObsidianPluginRepoPaths from './ObsidianPluginRepoPaths.mjs';
+export * as Plugin from './Plugin.mjs';
+export * as PluginBase from './PluginBase.mjs';
+export * as PluginContext from './PluginContext.mjs';
+export * as PluginId from './PluginId.mjs';
+export * as PluginSettingsBase from './PluginSettingsBase.mjs';
+export * as PluginSettingsTabBase from './PluginSettingsTabBase.mjs';

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

@@ -0,0 +1,26 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function initEsm(){if(globalThis.process){return}const browserProcess={browser:true,cwd:__name(()=>"/","cwd"),env:{},platform:"android"};globalThis.process=browserProcess})();
+
+import * as EmptySettings from "./EmptySettings.mjs";
+import * as ObsidianPluginRepoPaths from "./ObsidianPluginRepoPaths.mjs";
+import * as Plugin from "./Plugin.mjs";
+import * as PluginBase from "./PluginBase.mjs";
+import * as PluginContext from "./PluginContext.mjs";
+import * as PluginId from "./PluginId.mjs";
+import * as PluginSettingsBase from "./PluginSettingsBase.mjs";
+import * as PluginSettingsTabBase from "./PluginSettingsTabBase.mjs";
+export {
+  EmptySettings,
+  ObsidianPluginRepoPaths,
+  Plugin,
+  PluginBase,
+  PluginContext,
+  PluginId,
+  PluginSettingsBase,
+  PluginSettingsTabBase
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL1BsdWdpbi9pbmRleC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyogVEhJUyBJUyBBIEdFTkVSQVRFRC9CVU5ETEVEIEZJTEUgQlkgQlVJTEQgU0NSSVBUICovXG5cbmV4cG9ydCAqIGFzIEVtcHR5U2V0dGluZ3MgZnJvbSAnLi9FbXB0eVNldHRpbmdzLnRzJztcbmV4cG9ydCAqIGFzIE9ic2lkaWFuUGx1Z2luUmVwb1BhdGhzIGZyb20gJy4vT2JzaWRpYW5QbHVnaW5SZXBvUGF0aHMudHMnO1xuZXhwb3J0ICogYXMgUGx1Z2luIGZyb20gJy4vUGx1Z2luLnRzJztcbmV4cG9ydCAqIGFzIFBsdWdpbkJhc2UgZnJvbSAnLi9QbHVnaW5CYXNlLnRzJztcbmV4cG9ydCAqIGFzIFBsdWdpbkNvbnRleHQgZnJvbSAnLi9QbHVnaW5Db250ZXh0LnRzJztcbmV4cG9ydCAqIGFzIFBsdWdpbklkIGZyb20gJy4vUGx1Z2luSWQudHMnO1xuZXhwb3J0ICogYXMgUGx1Z2luU2V0dGluZ3NCYXNlIGZyb20gJy4vUGx1Z2luU2V0dGluZ3NCYXNlLnRzJztcbmV4cG9ydCAqIGFzIFBsdWdpblNldHRpbmdzVGFiQmFzZSBmcm9tICcuL1BsdWdpblNldHRpbmdzVGFiQmFzZS50cyc7XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7O0FBRUEsWUFBWSxtQkFBbUI7QUFDL0IsWUFBWSw2QkFBNkI7QUFDekMsWUFBWSxZQUFZO0FBQ3hCLFlBQVksZ0JBQWdCO0FBQzVCLFlBQVksbUJBQW1CO0FBQy9CLFlBQVksY0FBYztBQUMxQixZQUFZLHdCQUF3QjtBQUNwQyxZQUFZLDJCQUEyQjsiLAogICJuYW1lcyI6IFtdCn0K

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

@@ -3,7 +3,7 @@
  * Contains utility functions for enqueuing and processing functions in Obsidian.
  */
 import type { App } from 'obsidian';
-import type { MaybePromise } from '../Async.ts';
+import type { MaybePromise } from '../Async.cjs';
 /**
  * Adds an asynchronous function to be executed after the previous function completes.
  *

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

@@ -0,0 +1,30 @@
+/**
+ * @packageDocumentation Queue
+ * Contains utility functions for enqueuing and processing functions in Obsidian.
+ */
+import type { App } from 'obsidian';
+import type { MaybePromise } from '../Async.mjs';
+/**
+ * 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/obsidian/{Reference.d.ts → Reference.d.cts}

@@ -3,7 +3,7 @@
  * Contains utility functions for handling references in Obsidian.
  */
 import type { Reference } from 'obsidian';
-import type { FileChange } from './FileChange.ts';
+import type { FileChange } from './FileChange.cjs';
 /**
  * Converts a reference to a file change.
  *

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

@@ -0,0 +1,21 @@
+/**
+ * @packageDocumentation Reference
+ * Contains utility functions for handling references in Obsidian.
+ */
+import type { Reference } from 'obsidian';
+import type { FileChange } from './FileChange.mjs';
+/**
+ * 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[];

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

@@ -0,0 +1,49 @@
+/**
+ * @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/obsidian/ResourceUrl.d.mts

@@ -0,0 +1,14 @@
+/**
+ * @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/obsidian/{SettingEx.d.ts → SettingEx.d.cts}

@@ -4,19 +4,19 @@
  */
 import type { BaseComponent } from 'obsidian';
 import { Setting } from 'obsidian';
-import { DateComponent } from './Components/DateComponent.ts';
-import { DateTimeComponent } from './Components/DateTimeComponent.ts';
-import { EmailComponent } from './Components/EmailComponent.ts';
-import { FileComponent } from './Components/FileComponent.ts';
-import { MonthComponent } from './Components/MonthComponent.ts';
-import { MultipleDropdownComponent } from './Components/MultipleDropdownComponent.ts';
-import { MultipleEmailComponent } from './Components/MultipleEmailComponent.ts';
-import { MultipleFileComponent } from './Components/MultipleFileComponent.ts';
-import { MultipleTextComponent } from './Components/MultipleTextComponent.ts';
-import { NumberComponent } from './Components/NumberComponent.ts';
-import { TimeComponent } from './Components/TimeComponent.ts';
-import { UrlComponent } from './Components/UrlComponent.ts';
-import { WeekComponent } from './Components/WeekComponent.ts';
+import { DateComponent } from './Components/DateComponent.cjs';
+import { DateTimeComponent } from './Components/DateTimeComponent.cjs';
+import { EmailComponent } from './Components/EmailComponent.cjs';
+import { FileComponent } from './Components/FileComponent.cjs';
+import { MonthComponent } from './Components/MonthComponent.cjs';
+import { MultipleDropdownComponent } from './Components/MultipleDropdownComponent.cjs';
+import { MultipleEmailComponent } from './Components/MultipleEmailComponent.cjs';
+import { MultipleFileComponent } from './Components/MultipleFileComponent.cjs';
+import { MultipleTextComponent } from './Components/MultipleTextComponent.cjs';
+import { NumberComponent } from './Components/NumberComponent.cjs';
+import { TimeComponent } from './Components/TimeComponent.cjs';
+import { UrlComponent } from './Components/UrlComponent.cjs';
+import { WeekComponent } from './Components/WeekComponent.cjs';
 /**
  * Extends the Setting class with additional methods for adding components.
  */