obsidian-dev-utils 19.0.0 → 19.1.0

package/dist/lib/obsidian/Components/TypedRangeTextComponent.d.mts

@@ -1,31 +1 @@
-/**
- * @packageDocumentation TypedRangeTextComponent
- * Contains a component that displays and edits a text-based value with a range.
- */
-import { TypedTextComponent } from './TypedTextComponent.mjs';
-/**
- * A component that displays and edits a text-based value with a range.
- */
-export declare abstract class TypedRangeTextComponent<T> extends TypedTextComponent<T> {
-    /**
-     * Sets the maximum value of the component.
-     *
-     * @param max - The maximum value.
-     * @returns The component.
-     */
-    setMax(max: T): this;
-    /**
-     * Sets the minimum value of the component.
-     *
-     * @param min - The minimum value.
-     * @returns The component.
-     */
-    setMin(min: T): this;
-    /**
-     * Sets the step value of the component.
-     *
-     * @param step - The step value.
-     * @returns The component.
-     */
-    setStep(step: number): this;
-}
+export * from './TypedRangeTextComponent.cjs';

package/dist/lib/obsidian/Components/TypedTextComponent.d.mts

@@ -1,84 +1 @@
-/**
- * @packageDocumentation TypedTextComponent
- * Contains a component that displays and edits a text-based value.
- */
-import { ValueComponent } from 'obsidian';
-import type { MaybePromise } from '../../Async.mjs';
-import type { ValidatorElement } from '../../HTMLElement.mjs';
-import type { ValidatorComponent } from './ValidatorComponent.mjs';
-import type { ValueComponentWithChangeTracking } from './ValueComponentWithChangeTracking.mjs';
-import { CssClass } from '../../CssClass.mjs';
-/**
- * A component that displays and edits a text-based value.
- */
-export declare abstract class TypedTextComponent<T> extends ValueComponent<T> implements ValidatorComponent, ValueComponentWithChangeTracking<T> {
-    /**
-     * The input element of the component.
-     */
-    readonly inputEl: HTMLInputElement;
-    /**
-     * The validator element of the component.
-     */
-    get validatorEl(): ValidatorElement;
-    private readonly textComponent;
-    /**
-     * Creates a new typed text component.
-     *
-     * @param containerEl - The container element of the component.
-     * @param type - The type of the input element.
-     * @param cssClass - The CSS class of the component.
-     */
-    constructor(containerEl: HTMLElement, type: string, cssClass: CssClass);
-    /**
-     * Gets the value of the component.
-     *
-     * @returns The value of the component.
-     */
-    getValue(): T;
-    /**
-     * Sets the callback function to be called when the component is changed.
-     *
-     * @param callback - The callback function to be called when the component is changed.
-     * @returns The component.
-     */
-    onChange(callback: (value: T) => MaybePromise<void>): this;
-    /**
-     * Called when the component is changed.
-     */
-    onChanged(): void;
-    /**
-     * Sets the disabled state of the component.
-     *
-     * @param disabled - Whether the component is disabled.
-     * @returns The component.
-     */
-    setDisabled(disabled: boolean): this;
-    /**
-     * Sets the placeholder of the component.
-     *
-     * @param placeholder - The placeholder to set.
-     * @returns The component.
-     */
-    setPlaceholder(placeholder: string): this;
-    /**
-     * Sets the value of the component.
-     *
-     * @param value - The value to set.
-     * @returns The component.
-     */
-    setValue(value: T): this;
-    /**
-     * Converts a string to a value.
-     *
-     * @param str - The string to convert.
-     * @returns The value.
-     */
-    abstract valueFromString(str: string): T;
-    /**
-     * Converts a value to a string.
-     *
-     * @param value - The value to convert.
-     * @returns The string.
-     */
-    valueToString(value: T): string;
-}
+export * from './TypedTextComponent.cjs';

package/dist/lib/obsidian/Components/UrlComponent.d.mts

@@ -1,29 +1 @@
-/**
- * @packageDocumentation UrlComponent
- * Contains a component that displays and edits an url.
- */
-import { TypedTextComponent } from './TypedTextComponent.mjs';
-/**
- * A component that displays and edits an url.
- *
- * You can add this component using {@link SettingEx.addUrl}.
- *
- * In order to add the styles for the component, use {@link initPluginContext} in your plugin's `onload()` function.
- *
- * Alternatively, you can copy styles from {@link https://github.com/mnaoumov/obsidian-dev-utils/releases/latest/download/styles.css}.
- */
-export declare class UrlComponent extends TypedTextComponent<string> {
-    /**
-     * Creates a new Url component.
-     *
-     * @param containerEl - The container element of the component.
-     */
-    constructor(containerEl: HTMLElement);
-    /**
-     * Converts a string to an url.
-     *
-     * @param str - The string to convert.
-     * @returns The url.
-     */
-    valueFromString(str: string): string;
-}
+export * from './UrlComponent.cjs';

package/dist/lib/obsidian/Components/ValidatorComponent.d.mts

@@ -1,22 +1 @@
-/**
- * @packageDocumentation ValidatorComponent
- * Contains a component that has a validator element.
- */
-import type { BaseComponent } from 'obsidian';
-import type { ValidatorElement } from '../../HTMLElement.mjs';
-/**
- * A component that has a validator element.
- */
-export interface ValidatorComponent {
-    /**
-     * The validator element of the component.
-     */
-    readonly validatorEl: ValidatorElement;
-}
-/**
- * Gets a validator component related to the base component
- *
- * @param baseComponent - A base component
- * @returns related validator component or `null` if no related validator component is found
- */
-export declare function getValidatorComponent(baseComponent: BaseComponent): null | ValidatorComponent;
+export * from './ValidatorComponent.cjs';

package/dist/lib/obsidian/Components/ValueComponentWithChangeTracking.d.mts

@@ -1,17 +1 @@
-/**
- * @packageDocumentation ValueComponentWithChangeTracking
- * Contains a type that extends ValueComponent to allow for change tracking.
- */
-import { ValueComponent } from 'obsidian';
-import type { MaybePromise } from '../../Async.mjs';
-/**
- * A ValueComponent that can track changes.
- */
-export interface ValueComponentWithChangeTracking<T> extends ValueComponent<T> {
-    /**
-     * Sets a callback function to be called when the value of the component changes.
-     *
-     * @param callback - A callback function that is called when the value of the component changes.
-     */
-    onChange(callback: (newValue: T) => MaybePromise<void>): this;
-}
+export * from './ValueComponentWithChangeTracking.cjs';

package/dist/lib/obsidian/Components/WeekComponent.d.mts

@@ -1,49 +1 @@
-/**
- * @packageDocumentation WeekComponent
- * Contains a component that displays and edits a week.
- */
-import { TypedRangeTextComponent } from './TypedRangeTextComponent.mjs';
-/**
- * Represents an ISO 8601 week date.
- */
-export interface IsoWeek {
-    /**
-     * The ISO 8601 week number (1-53).
-     */
-    weekNumber: number;
-    /**
-     * The year (1-9999).
-     */
-    year: number;
-}
-/**
- * A component that displays and edits a Week.
- *
- * You can add this component using {@link SettingEx.addWeek}.
- *
- * In order to add the styles for the component, use {@link initPluginContext} in your plugin's `onload()` function.
- *
- * Alternatively, you can copy styles from {@link https://github.com/mnaoumov/obsidian-dev-utils/releases/latest/download/styles.css}.
- */
-export declare class WeekComponent extends TypedRangeTextComponent<IsoWeek> {
-    /**
-     * Creates a new Week component.
-     *
-     * @param containerEl - The container element of the component.
-     */
-    constructor(containerEl: HTMLElement);
-    /**
-     * Converts a string to a Week.
-     *
-     * @param str - The string to convert.
-     * @returns The week.
-     */
-    valueFromString(str: string): IsoWeek;
-    /**
-     * Converts a week to a string.
-     *
-     * @param value - The week to convert.
-     * @returns The string.
-     */
-    valueToString(value: IsoWeek): string;
-}
+export * from './WeekComponent.cjs';

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

@@ -1,17 +1 @@
-export * as DateComponent from './DateComponent.mjs';
-export * as DateTimeComponent from './DateTimeComponent.mjs';
-export * as EmailComponent from './EmailComponent.mjs';
-export * as FileComponent from './FileComponent.mjs';
-export * as MonthComponent from './MonthComponent.mjs';
-export * as MultipleDropdownComponent from './MultipleDropdownComponent.mjs';
-export * as MultipleEmailComponent from './MultipleEmailComponent.mjs';
-export * as MultipleFileComponent from './MultipleFileComponent.mjs';
-export * as MultipleTextComponent from './MultipleTextComponent.mjs';
-export * as NumberComponent from './NumberComponent.mjs';
-export * as TimeComponent from './TimeComponent.mjs';
-export * as TypedRangeTextComponent from './TypedRangeTextComponent.mjs';
-export * as TypedTextComponent from './TypedTextComponent.mjs';
-export * as UrlComponent from './UrlComponent.mjs';
-export * as ValidatorComponent from './ValidatorComponent.mjs';
-export * as ValueComponentWithChangeTracking from './ValueComponentWithChangeTracking.mjs';
-export * as WeekComponent from './WeekComponent.mjs';
+export * from './index.cjs';

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

@@ -1,215 +1 @@
-/**
- * @packageDocumentation Dataview
- * This module provides utility functions for working with Dataview in Obsidian.
- */
-import type { MaybePromise } from '../Async.mjs';
-import type { DataviewInlineApi as DataviewInlineApiOriginal } from './@types/Dataview/api/inline-api.d.mjs';
-import type { DataArray, DataviewApi, SMarkdownPage } from './@types/Dataview/index.d.mjs';
-import type { PathOrFile } from './FileSystem.mjs';
-import type { CombinedFrontmatter } from './Frontmatter.mjs';
-/**
- * Export DateTime and Link types from the Dataview API.
- */
-export type { DateTime, Link } from './@types/Dataview/index.d.mjs';
-declare global {
-    /**
-     * The DataviewAPI object represents the API for interacting with Dataview in Obsidian.
-     */
-    var DataviewAPI: DataviewApi | undefined;
-}
-/**
- * The combined page type, which includes the front matter and the SMarkdownPage.
- */
-export type CombinedPage<CustomFrontmatter = unknown> = CombinedFrontmatter<CustomFrontmatter> & SMarkdownPage;
-/**
- * Extended interface for the Dataview Inline API, providing additional methods for custom page types and array handling.
- *
- * @typeParam CustomPage - The type of the custom page. Defaults to `SMarkdownPage`.
- */
-export interface DataviewInlineApi extends DataviewInlineApiOriginal {
-    /**
-     * Wraps an array of items into a `DataArray` object.
-     *
-     * @typeParam T - The type of the items in the array.
-     * @param arr - The array of items to wrap.
-     * @returns A `DataArray` containing the items.
-     */
-    array<T>(arr: T[]): DataArray<T>;
-    /**
-     * Retrieves the current page, with an optional custom page type.
-     *
-     * @typeParam CustomPage - The type of the custom page. Defaults to `SMarkdownPage`.
-     * @returns The current page.
-     */
-    current<CustomFrontmatter = unknown>(): CombinedPage<CustomFrontmatter>;
-    /**
-     * Retrieves pages based on an optional query, with an optional custom page type.
-     *
-     * @typeParam CustomPage - The type of the custom page. Defaults to `SMarkdownPage`.
-     * @param query - An optional string query to filter the pages.
-     * @returns A `DataArray` of pages matching the query.
-     */
-    pages<CustomFrontmatter = unknown>(query?: string): DataArray<CombinedPage<CustomFrontmatter>>;
-    /**
-     * Creates a paragraph HTML element with the provided text and optional DOM element options.
-     *
-     * @param text - The content of the paragraph.
-     * @param options - Optional DOM element options, including an optional container.
-     * @returns The created HTML paragraph element.
-     */
-    paragraph(text: unknown, options?: DomElementInfoWithContainer): HTMLParagraphElement;
-}
-/**
- * DomElementInfo with an optional container.
- */
-export type DomElementInfoWithContainer = {
-    container?: HTMLElement;
-} & DomElementInfo;
-/**
- * The combined file type, which includes the front matter and the SMarkdownFile.
- */
-export type PageFile = SMarkdownPage['file'];
-/**
- * List of page files.
- */
-export type PageFiles = ArrayOrDataArray<PageFile>;
-/**
- * Reloads the current file cache using the Dataview API.
- *
- * @param dv - The DataviewInlineApi instance.
- * @returns A promise that resolves when the cache is reloaded.
- */
-export declare function reloadCurrentFileCache(dv: DataviewInlineApi): Promise<void>;
-/**
- * Array or DataArray type.
- */
-export type ArrayOrDataArray<T> = DataArray<T> | T[];
-/**
- * Options for rendering an iframe in the Dataview container.
- */
-export interface RenderIframeOptions {
-    /**
-     * The DataviewInlineApi instance.
-     */
-    dv: DataviewInlineApi;
-    /**
-     * The height of the iframe.
-     */
-    height: string;
-    /**
-     * The relative path to the resource to be displayed in the iframe.
-     */
-    relativePathOrFile: PathOrFile;
-    /**
-     * The width of the iframe.
-     */
-    width: string;
-}
-/**
- * Options for rendering a paginated list using the Dataview API.
- */
-export interface RenderPaginatedListOptions<T> {
-    /**
-     * The DataviewInlineApi instance.
-     */
-    dv: DataviewInlineApi;
-    /**
-     * Options for items per page. Defaults to `[10, 20, 50, 100]`.
-     */
-    itemsPerPageOptions?: number[];
-    /**
-     * The list of items to paginate.
-     */
-    rows: ArrayOrDataArray<T>;
-}
-/**
- * Options for rendering a paginated element using the Dataview API.
- */
-export interface RenderPaginatedOptions<T> {
-    /**
-     * The DataviewInlineApi instance.
-     */
-    dv: DataviewInlineApi;
-    /**
-     * Options for items per page.
-     */
-    itemsPerPageOptions: number[];
-    /**
-     * The renderer function to display the paginated content.
-     * @param rowsForOnePage - The rows to render.
-     * @returns A promise that resolves when the content is rendered.
-     */
-    renderer: (rowsForOnePage: ArrayOrDataArray<T>) => MaybePromise<void>;
-    /**
-     * The rows to paginate.
-     */
-    rows: ArrayOrDataArray<T>;
-}
-/**
- * Options for rendering a paginated table using the Dataview API.
- */
-export interface RenderPaginatedTableOptions<T> {
-    /**
-     * The DataviewInlineApi instance.
-     */
-    dv: DataviewInlineApi;
-    /**
-     * The headers of the table.
-     */
-    headers: string[];
-    /**
-     * Options for items per page. Defaults to `[10, 20, 50, 100]`.
-     */
-    itemsPerPageOptions?: number[];
-    /**
-     * The rows of the table to paginate.
-     */
-    rows: ArrayOrDataArray<T>;
-}
-/**
- * Renders the content using the provided renderer function in a temporary container,
- * and then returns the container.
- *
- * @param dv - The DataviewInlineApi instance.
- * @param renderer - The function responsible for rendering the content.
- * @returns A promise that resolves to the HTML paragraph element
- * that was used as the temporary container.
- */
-export declare function getRenderedContainer(dv: DataviewInlineApi, renderer: () => MaybePromise<void>): Promise<HTMLParagraphElement>;
-/**
- * Inserts a code block into the specified Dataview instance using the provided language and code.
- *
- * @param dv - The DataviewInlineApi instance to insert the code block into.
- * @param language - The language identifier for the code block.
- * @param code - The code content to be inserted into the code block.
- * @returns This function does not return a value.
- */
-export declare function insertCodeBlock(dv: DataviewInlineApi, language: string, code: string): void;
-/**
- * Renders an iframe in the Dataview container with the specified relative path, width, and height.
- *
- * @param options - The options for rendering the iframe.
- *
- * @returns This function does not return a value.
- */
-export declare function renderIframe(options: RenderIframeOptions): void;
-/**
- * Renders a paginated list using the provided DataviewInlineApi instance.
- *
- * @typeParam T - The type of items in the list.
- *
- * @param options - The options for rendering the paginated list.
- *
- * @returns A promise that resolves when the list is rendered.
- */
-export declare function renderPaginatedList<T>(options: RenderPaginatedListOptions<T>): Promise<void>;
-/**
- * Renders a paginated table using the provided DataviewInlineApi instance.
- *
- * @typeParam T - The type of items in the table rows.
- *
- * @param options - The options for rendering the paginated table.
- *
- * @returns A promise that resolves when the table is rendered.
- */
-export declare function renderPaginatedTable<T extends unknown[]>(options: RenderPaginatedTableOptions<T>): Promise<void>;
+export * from './Dataview.cjs';

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

@@ -1,23 +1 @@
-/**
- * @packageDocumentation DataviewLink
- * This module provides utility functions for working with Dataview links in Obsidian
- */
-import type { DataviewInlineApi, Link } from './Dataview.mjs';
-import type { PathOrFile } from './FileSystem.mjs';
-/**
- * Fixes the title of a file or folder note by generating a `Link` object with a proper title.
- *
- * @param dv - The DataviewInlineApi instance used to create the file link.
- * @param pathOrFile - The file path for which the title is to be fixed.
- * @param isFolderNote - A boolean indicating whether the file is a folder note. Defaults to `false`.
- * If true, the title is derived from the folder name. Defaults to `false`.
- * @returns A Link object with the corrected title.
- */
-export declare function fixTitle(dv: DataviewInlineApi, pathOrFile: PathOrFile, isFolderNote?: boolean): Link;
-/**
- * Generates a string representation of a `Link` object that includes both the link text and the file path.
- *
- * @param link - The Link object to be converted to a string with its path.
- * @returns A string representing the link in the format: "linkText (linkPath)".
- */
-export declare function makeLinkWithPath(link: Link): string;
+export * from './DataviewLink.cjs';

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

@@ -1,68 +1 @@
-/**
- * @packageDocumentation FileChange
- * Contains utility types and functions for handling file changes in Obsidian.
- */
-import type { App } from 'obsidian';
-import type { ValueProvider } from '../ValueProvider.mjs';
-import type { PathOrFile } from './FileSystem.mjs';
-import type { ProcessOptions } from './Vault.mjs';
-/**
- * Represents a content body change in the Vault.
- */
-export interface ContentChange extends FileChange {
-    /**
-     * The end index of the change in the file content.
-     */
-    endIndex: number;
-    /**
-     * The start index of the change in the file content.
-     */
-    startIndex: number;
-}
-/**
- * Represents a file change in the Vault.
- */
-export interface FileChange {
-    /**
-     * The new content to replace the old content.
-     */
-    newContent: string;
-    /**
-     * The old content that will be replaced.
-     */
-    oldContent: string;
-}
-/**
- * Represents a frontmatter change in the Vault.
- */
-export interface FrontmatterChange extends FileChange {
-    /**
-     * The key in the frontmatter to use for the link.
-     */
-    frontmatterKey: string;
-}
-/**
- * Applies a series of file changes to the specified file or path within the application.
- *
- * @param app - The application instance where the file changes will be applied.
- * @param pathOrFile - The path or file to which the changes should be applied.
- * @param changesProvider - A provider that returns an array of file changes to apply.
- * @param processOptions - Optional options for processing/retrying the operation.
- *
- * @returns A promise that resolves when the file changes have been successfully applied.
- */
-export declare function applyFileChanges(app: App, pathOrFile: PathOrFile, changesProvider: ValueProvider<FileChange[]>, processOptions?: ProcessOptions): Promise<void>;
-/**
- * Checks if a file change is a content change.
- *
- * @param fileChange - The file change to check.
- * @returns A boolean indicating whether the file change is a content change.
- */
-export declare function isContentChange(fileChange: FileChange): fileChange is ContentChange;
-/**
- * Checks if a file change is a frontmatter change.
- *
- * @param fileChange - The file change to check.
- * @returns A boolean indicating whether the file change is a frontmatter change.
- */
-export declare function isFrontmatterChange(fileChange: FileChange): fileChange is FrontmatterChange;
+export * from './FileChange.cjs';

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

@@ -1,38 +1 @@
-/**
- * @packageDocumentation FileManager
- * Contains utility functions for managing files in Obsidian.
- */
-import type { App } from 'obsidian';
-import type { MaybePromise } from '../Async.mjs';
-import type { PathOrFile } from './FileSystem.mjs';
-import type { CombinedFrontmatter } from './Frontmatter.mjs';
-import type { ProcessOptions } from './Vault.mjs';
-/**
- * Adds an alias to the front matter of a given file if it does not already exist.
- *
- * @param app - The Obsidian app instance.
- * @param pathOrFile - The path or TFile object representing the note.
- * @param alias - The alias to add.
- * @returns A promise that resolves when the alias has been added.
- */
-export declare function addAlias(app: App, pathOrFile: PathOrFile, alias?: string): Promise<void>;
-/**
- * Deletes an alias from the front matter of a given file if it exists.
- *
- * @param app - The Obsidian app instance.
- * @param pathOrFile - The path or TFile object representing the note.
- * @param alias - The alias to delete.
- * @returns A promise that resolves when the alias has been deleted.
- */
-export declare function deleteAlias(app: App, pathOrFile: PathOrFile, alias?: string): Promise<void>;
-/**
- * Processes the front matter of a given file, allowing modifications via a provided function.
- *
- * @typeParam CustomFrontmatter - The type of custom front matter.
- * @param app - The Obsidian app instance.
- * @param pathOrFile - The path or TFile object representing the note.
- * @param frontmatterFn - A function that modifies the front matter.
- * @param processOptions - Optional. Configuration options for retrying the process. If not provided, default options will be used.
- * @returns A promise that resolves when the front matter has been processed and saved.
- */
-export declare function processFrontmatter<CustomFrontmatter = unknown>(app: App, pathOrFile: PathOrFile, frontmatterFn: (frontmatter: CombinedFrontmatter<CustomFrontmatter>) => MaybePromise<null | void>, processOptions?: ProcessOptions): Promise<void>;
+export * from './FileManager.cjs';