obsidian-dev-utils 19.0.0 → 19.0.1

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

@@ -1,54 +1 @@
-/**
- * @packageDocumentation AttachmentPath
- * Provides utility functions for working with attachment paths.
- */
-import type { App, TFile } from 'obsidian';
-import type { PathOrFile } from './FileSystem.mjs';
-/**
- * Is overridden wrapper.
- */
-export interface ExtendedWrapper {
-    /**
-     * Is extended.
-     */
-    isExtended: true;
-}
-/**
- * Get available path for attachments function.
- */
-export type GetAvailablePathForAttachmentsExtendedFn = (filename: string, extension: string, file: null | TFile, shouldSkipFolderCreation?: boolean) => Promise<string>;
-/**
- * Retrieves the file path for an attachment within a note.
- *
- * @param app - The Obsidian application instance.
- * @param attachmentPathOrFile - The path of the attachment.
- * @param notePathOrFile - The path of the note.
- * @returns A promise that resolves to the file path of the attachment.
- */
-export declare function getAttachmentFilePath(app: App, attachmentPathOrFile: PathOrFile, notePathOrFile: PathOrFile): Promise<string>;
-/**
- * Retrieves the attachment folder path for a given note.
- *
- * @param app - The Obsidian application instance.
- * @param notePathOrFile - The path of the note.
- * @returns A promise that resolves to the attachment folder path.
- */
-export declare function getAttachmentFolderPath(app: App, notePathOrFile: PathOrFile): Promise<string>;
-/**
- * Retrieves the available path for attachments.
- * @param app - The Obsidian application instance.
- * @param filename - Name of the file.
- * @param extension - Extension of the file.
- * @param file - The file to attach to.
- * @param shouldSkipFolderCreation - Should folder creation be skipped?
- * @returns A promise that resolves to the available path for attachments.
- */
-export declare function getAvailablePathForAttachments(app: App, filename: string, extension: string, file: null | TFile, shouldSkipFolderCreation: boolean): Promise<string>;
-/**
- * Checks if a note has its own attachment folder.
- *
- * @param app - The Obsidian application instance.
- * @param path - The path of the note.
- * @returns A promise that resolves to a boolean indicating whether the note has its own attachment folder.
- */
-export declare function hasOwnAttachmentFolder(app: App, path: string): Promise<boolean>;
+export * from './AttachmentPath.cjs';

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

@@ -1,60 +1 @@
-/**
- * @packageDocumentation Backlink
- * Provides utility functions for working with backlinks.
- */
-import type { DataviewInlineApi } from './Dataview.mjs';
-import type { PathOrAbstractFile, PathOrFile } from './FileSystem.mjs';
-/**
- * Options for rendering delayed backlinks for a folder.
- */
-export interface RenderDelayedBacklinksForFolderOptions {
-    /**
-     * The DataviewInlineApi instance.
-     */
-    dv: DataviewInlineApi;
-    /**
-     * The folder path. If not provided, the current file's folder will be used.
-     */
-    folder?: string;
-    /**
-     * The title for the rendered backlinks. Defaults to "Folder Backlinks".
-     */
-    title?: string;
-}
-/**
- * Options for rendering delayed backlinks.
- */
-export interface RenderDelayedBacklinksOptions {
-    /**
-     * The DataviewInlineApi instance.
-     */
-    dv: DataviewInlineApi;
-    /**
-     * An array of PathOrFile.
-     */
-    files: PathOrFile[];
-    /**
-     * The title for the rendered backlinks. Defaults to "Backlinks".
-     */
-    title?: string;
-}
-/**
- * Renders a backlinks table using the provided DataviewInlineApi and optional array of PathOrAbstractFile.
- *
- * @param dv - The DataviewInlineApi instance.
- * @param pathOrFiles - An optional array of PathOrAbstractFile.
- * @returns A Promise that resolves when the backlinks table has been rendered.
- */
-export declare function renderBacklinksTable(dv: DataviewInlineApi, pathOrFiles?: PathOrAbstractFile[]): Promise<void>;
-/**
- * Renders delayed backlinks.
- *
- * @param options - The options for rendering delayed backlinks.
- */
-export declare function renderDelayedBacklinks(options: RenderDelayedBacklinksOptions): void;
-/**
- * Renders delayed backlinks for a specific folder.
- *
- * @param options - The options for rendering delayed backlinks.
- */
-export declare function renderDelayedBacklinksForFolder(options: RenderDelayedBacklinksForFolderOptions): void;
+export * from './Backlink.cjs';

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

@@ -1,55 +1 @@
-/**
- * @packageDocumentation Callout
- * This module provides utility functions for rendering callouts in Dataview.
- */
-import type { ValueProvider } from '../ValueProvider.mjs';
-import type { DataviewInlineApi } from './Dataview.mjs';
-/**
- * Enum representing the mode of a callout.
- */
-export declare enum CalloutMode {
-    /** Default mode, with no special behavior. */
-    Default = 0,
-    /** Foldable mode with the callout collapsed. */
-    FoldableCollapsed = 1,
-    /** Foldable mode with the callout expanded. */
-    FoldableExpanded = 2
-}
-/**
- * Options for rendering a callout block in Dataview.
- */
-export interface RenderCalloutOptions {
-    /**
-     * An optional provider for the content, which can be either a string or a Node.
-     */
-    contentProvider?: ValueProvider<Node | string | void>;
-    /**
-     * The DataviewInlineApi instance.
-     */
-    dv: DataviewInlineApi;
-    /**
-     * The header text of the callout, default is an empty string.
-     */
-    header?: string;
-    /**
-     * The callout mode, default is `CalloutMode.FoldableCollapsed`.
-     */
-    mode?: CalloutMode;
-    /**
-     * The type of the callout, default is `"NOTE"`.
-     */
-    type?: string;
-}
-/**
- * Renders a callout block in Dataview.
- *
- * @param options - The options for rendering the callout.
- */
-export declare function renderCallout(options: RenderCalloutOptions): void;
-/**
- * Wraps the provided content in blockquote syntax for a callout.
- *
- * @param content - The content to wrap.
- * @returns The content wrapped in blockquote syntax.
- */
-export declare function wrapForCallout(content: string): string;
+export * from './Callout.cjs';

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

@@ -1,36 +1 @@
-/**
- * @packageDocumentation DateComponent
- * Contains a component that displays and edits a date.
- */
-import { TypedRangeTextComponent } from './TypedRangeTextComponent.mjs';
-/**
- * A component that displays and edits a date.
- *
- * You can add this component using {@link SettingEx.addDate}.
- *
- * 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 DateComponent extends TypedRangeTextComponent<Date> {
-    /**
-     * Creates a new date component.
-     *
-     * @param containerEl - The container element of the component.
-     */
-    constructor(containerEl: HTMLElement);
-    /**
-     * Converts a string to a date.
-     *
-     * @param str - The string to convert.
-     * @returns The date.
-     */
-    valueFromString(str: string): Date;
-    /**
-     * Converts a date to a string.
-     *
-     * @param value - The date to convert.
-     * @returns The string.
-     */
-    valueToString(value: Date): string;
-}
+export * from './DateComponent.cjs';

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

@@ -1,36 +1 @@
-/**
- * @packageDocumentation DateTimeComponent
- * Contains a component that displays and edits a date and time.
- */
-import { TypedRangeTextComponent } from './TypedRangeTextComponent.mjs';
-/**
- * A component that displays and edits a date and time.
- *
- * You can add this component using {@link SettingEx.addDateTime}.
- *
- * 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 DateTimeComponent extends TypedRangeTextComponent<Date> {
-    /**
-     * Creates a new date and time component.
-     *
-     * @param containerEl - The container element of the component.
-     */
-    constructor(containerEl: HTMLElement);
-    /**
-     * Converts a string to a date.
-     *
-     * @param str - The string to convert.
-     * @returns The date.
-     */
-    valueFromString(str: string): Date;
-    /**
-     * Converts a date to a string.
-     *
-     * @param value - The date to convert.
-     * @returns The string.
-     */
-    valueToString(value: Date): string;
-}
+export * from './DateTimeComponent.cjs';

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

@@ -1,29 +1 @@
-/**
- * @packageDocumentation EmailComponent
- * Contains a component that displays and edits an email address.
- */
-import { TypedTextComponent } from './TypedTextComponent.mjs';
-/**
- * A component that displays and edits an email address.
- *
- * You can add this component using {@link SettingEx.addEmail}.
- *
- * 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 EmailComponent extends TypedTextComponent<string> {
-    /**
-     * Creates a new email component.
-     *
-     * @param containerEl - The container element of the component.
-     */
-    constructor(containerEl: HTMLElement);
-    /**
-     * Converts a string to an email address.
-     *
-     * @param str - The string to convert.
-     * @returns The email address.
-     */
-    valueFromString(str: string): string;
-}
+export * from './EmailComponent.cjs';

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

@@ -1,41 +1 @@
-/**
- * @packageDocumentation FileComponent
- * Contains a component that displays and edits a file.
- */
-import { TypedTextComponent } from './TypedTextComponent.mjs';
-/**
- * A component that displays and edits a file.
- *
- * You can add this component using {@link SettingEx.addFile}.
- *
- * 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 FileComponent extends TypedTextComponent<File | null> {
-    /**
-     * Creates a new file component.
-     *
-     * @param containerEl - The container element of the component.
-     */
-    constructor(containerEl: HTMLElement);
-    /**
-     * Gets the value of the component.
-     *
-     * @returns The value of the component.
-     */
-    getValue(): File | null;
-    /**
-     * Converts a string to a file.
-     *
-     * @returns The file.
-     */
-    valueFromString(): File | null;
-    /**
-     * Converts a file to a string.
-     *
-     * @param value - The file to convert.
-     * @returns The string.
-     */
-    valueToString(value: File | null): string;
-}
+export * from './FileComponent.cjs';

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

@@ -1,49 +1 @@
-/**
- * @packageDocumentation MonthComponent
- * Contains a component that displays and edits a month.
- */
-import { TypedRangeTextComponent } from './TypedRangeTextComponent.mjs';
-/**
- * An ISO 8601 month.
- */
-export interface IsoMonth {
-    /**
-     * The month (1-12).
-     */
-    month: number;
-    /**
-     * The year (1-9999).
-     */
-    year: number;
-}
-/**
- * A component that displays and edits a month.
- *
- * You can add this component using {@link SettingEx.addMonth}.
- *
- * 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 MonthComponent extends TypedRangeTextComponent<IsoMonth> {
-    /**
-     * Creates a new month component.
-     *
-     * @param containerEl - The container element of the component.
-     */
-    constructor(containerEl: HTMLElement);
-    /**
-     * Converts a string to a month.
-     *
-     * @param str - The string to convert.
-     * @returns The month.
-     */
-    valueFromString(str: string): IsoMonth;
-    /**
-     * Converts a month to a string.
-     *
-     * @param value - The month to convert.
-     * @returns The string.
-     */
-    valueToString(value: IsoMonth): string;
-}
+export * from './MonthComponent.cjs';

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

@@ -1,73 +1 @@
-/**
- * @packageDocumentation MultipleDropdownComponent
- * Contains a component that displays and edits a multi-select dropdown.
- */
-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';
-/**
- * A multi-select dropdown component.
- *
- * You can add this component using {@link SettingEx.addMultipleDropdown}.
- *
- * 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 MultipleDropdownComponent extends ValueComponent<string[]> implements ValidatorComponent, ValueComponentWithChangeTracking<string[]> {
-    /**
-     * The validator element of the component.
-     */
-    get validatorEl(): ValidatorElement;
-    private readonly dropdownComponent;
-    /**
-     * Creates a new multiple dropdown component.
-     *
-     * @param containerEl - The container element of the component.
-     */
-    constructor(containerEl: HTMLElement);
-    /**
-     * Adds an option to the dropdown.
-     *
-     * @param value - The value of the option.
-     * @param display - The display text of the option.
-     * @returns The component.
-     */
-    addOption(value: string, display: string): this;
-    /**
-     * Adds multiple options to the dropdown.
-     *
-     * @param options - The options to add.
-     * @returns The component.
-     */
-    addOptions(options: Record<string, string>): this;
-    /**
-     * Gets the value of the component.
-     *
-     * @returns The value of the component.
-     */
-    getValue(): string[];
-    /**
-     * 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: string[]) => MaybePromise<void>): this;
-    /**
-     * Sets the disabled state of the component.
-     *
-     * @param disabled - The disabled state to set.
-     * @returns The component.
-     */
-    setDisabled(disabled: boolean): this;
-    /**
-     * Sets the value of the component.
-     *
-     * @param value - The value to set.
-     * @returns The component.
-     */
-    setValue(value: string[]): this;
-}
+export * from './MultipleDropdownComponent.cjs';

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

@@ -1,36 +1 @@
-/**
- * @packageDocumentation MultipleEmailComponent
- * Contains a component that displays and edits multiple email addresses.
- */
-import { TypedTextComponent } from './TypedTextComponent.mjs';
-/**
- * A component that displays and edits multiple email addresses.
- *
- * You can add this component using {@link SettingEx.addMultipleEmail}.
- *
- * 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 MultipleEmailComponent extends TypedTextComponent<string[]> {
-    /**
-     * Creates a new multiple emails component.
-     *
-     * @param containerEl - The container element of the component.
-     */
-    constructor(containerEl: HTMLElement);
-    /**
-     * Converts a string to an email address.
-     *
-     * @param str - The string to convert.
-     * @returns The email address.
-     */
-    valueFromString(str: string): string[];
-    /**
-     * Converts an email address to a string.
-     *
-     * @param value - The email address to convert.
-     * @returns The string.
-     */
-    valueToString(value: string[]): string;
-}
+export * from './MultipleEmailComponent.cjs';

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

@@ -1,41 +1 @@
-/**
- * @packageDocumentation MultipleFileComponent
- * Contains a component that displays and edits multiple files.
- */
-import { TypedTextComponent } from './TypedTextComponent.mjs';
-/**
- * A component that displays and edits multiple files.
- *
- * You can add this component using {@link SettingEx.addMultipleFile}.
- *
- * 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 MultipleFileComponent extends TypedTextComponent<File[]> {
-    /**
-     * Creates a new multiple file component.
-     *
-     * @param containerEl - The container element of the component.
-     */
-    constructor(containerEl: HTMLElement);
-    /**
-     * Gets the value of the component.
-     *
-     * @returns The value of the component.
-     */
-    getValue(): File[];
-    /**
-     * Converts a string to a file.
-     *
-     * @returns The file.
-     */
-    valueFromString(): File[];
-    /**
-     * Converts a file to a string.
-     *
-     * @param value - The file to convert.
-     * @returns The string.
-     */
-    valueToString(value: File[]): string;
-}
+export * from './MultipleFileComponent.cjs';

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

@@ -1,67 +1 @@
-/**
- * @packageDocumentation MultipleTextComponent
- * Contains a component that displays and edits multiple text values.
- */
-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';
-/**
- * A component that displays and edits multiple text values.
- *
- * You can add this component using {@link SettingEx.addMultipleText}.
- *
- * 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 MultipleTextComponent extends ValueComponent<string[]> implements ValidatorComponent, ValueComponentWithChangeTracking<string[]> {
-    /**
-     * Gets the validator element of the component.
-     *
-     * @returns The validator element of the component.
-     */
-    get validatorEl(): ValidatorElement;
-    private readonly textAreaComponent;
-    /**
-     * Creates a new multiple text component.
-     *
-     * @param containerEl - The container element of the component.
-     */
-    constructor(containerEl: HTMLElement);
-    /**
-     * Gets the value of the component.
-     *
-     * @returns The value of the component.
-     */
-    getValue(): string[];
-    /**
-     * Adds a change listener to the component.
-     *
-     * @param callback - The callback to call when the value changes.
-     * @returns The component.
-     */
-    onChange(callback: (newValue: string[]) => MaybePromise<void>): this;
-    /**
-     * Sets the disabled state of the component.
-     *
-     * @param disabled - The disabled state to set.
-     * @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: string[]): this;
-}
+export * from './MultipleTextComponent.cjs';

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

@@ -1,29 +1 @@
-/**
- * @packageDocumentation NumberComponent
- * Contains a component that displays and edits a number.
- */
-import { TypedRangeTextComponent } from './TypedRangeTextComponent.mjs';
-/**
- * A component that displays and edits a number.
- *
- * You can add this component using {@link SettingEx.addNumber}.
- *
- * 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 NumberComponent extends TypedRangeTextComponent<number> {
-    /**
-     * Creates a new number component.
-     *
-     * @param containerEl - The container element of the component.
-     */
-    constructor(containerEl: HTMLElement);
-    /**
-     * Converts a string to a number.
-     *
-     * @param str - The string to convert.
-     * @returns The number.
-     */
-    valueFromString(str: string): number;
-}
+export * from './NumberComponent.cjs';

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

@@ -1,37 +1 @@
-/**
- * @packageDocumentation TimeComponent
- * Contains a component that displays and edits a time.
- */
-import type { Duration } from 'moment';
-import { TypedRangeTextComponent } from './TypedRangeTextComponent.mjs';
-/**
- * A component that displays and edits a time.
- *
- * You can add this component using {@link SettingEx.addTime}.
- *
- * 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 TimeComponent extends TypedRangeTextComponent<Duration> {
-    /**
-     * Creates a new time component.
-     *
-     * @param containerEl - The container element of the component.
-     */
-    constructor(containerEl: HTMLElement);
-    /**
-     * Converts a string to a time.
-     *
-     * @param str - The string to convert.
-     * @returns The date.
-     */
-    valueFromString(str: string): Duration;
-    /**
-     * Converts a time to a string.
-     *
-     * @param value - The time to convert.
-     * @returns The string.
-     */
-    valueToString(value: Duration): string;
-}
+export * from './TimeComponent.cjs';