obsidian-dev-utils 18.4.0 → 19.0.0

package/dist/lib/obsidian/@types/Dataview/ui/views/js-view.d.mts

@@ -0,0 +1,23 @@
+import type { DataviewApi } from '../../api/plugin-api.d.mjs';
+import type { DataviewRefreshableRenderer } from '../../ui/refreshable-view.d.mjs';
+export declare class DataviewJSRenderer extends DataviewRefreshableRenderer {
+  api: DataviewApi;
+  script: string;
+  container: HTMLElement;
+  origin: string;
+  static PREAMBLE: string;
+  constructor(api: DataviewApi, script: string, container: HTMLElement, origin: string);
+  render(): Promise<void>;
+}
+/** Inline JS renderer accessible using '=$' by default. */
+export declare class DataviewInlineJSRenderer extends DataviewRefreshableRenderer {
+  api: DataviewApi;
+  script: string;
+  container: HTMLElement;
+  target: HTMLElement;
+  origin: string;
+  static PREAMBLE: string;
+  errorbox?: HTMLElement;
+  constructor(api: DataviewApi, script: string, container: HTMLElement, target: HTMLElement, origin: string);
+  render(): Promise<void>;
+}

package/dist/lib/obsidian/@types/Dataview/ui/views/{list-view.d.ts → list-view.d.cts}

@@ -1,8 +1,8 @@
 import type { MarkdownRenderChild } from 'obsidian';
 import type { h } from 'preact';
-import type { Literal } from '../../data-model/value.d.ts';
-import type { Query } from '../../query/query.d.ts';
-import type { DataviewInit } from '../../ui/markdown.d.ts';
+import type { Literal } from '../../data-model/value.d.cjs';
+import type { Query } from '../../query/query.d.cjs';
+import type { DataviewInit } from '../../ui/markdown.d.cjs';
 export declare function ListGrouping({ items, sourcePath }: {
   items: Literal[];
   sourcePath: string;

package/dist/lib/obsidian/@types/Dataview/ui/views/list-view.d.mts

@@ -0,0 +1,25 @@
+import type { MarkdownRenderChild } from 'obsidian';
+import type { h } from 'preact';
+import type { Literal } from '../../data-model/value.d.mjs';
+import type { Query } from '../../query/query.d.mjs';
+import type { DataviewInit } from '../../ui/markdown.d.mjs';
+export declare function ListGrouping({ items, sourcePath }: {
+  items: Literal[];
+  sourcePath: string;
+}): h.JSX.Element;
+export type ListViewState = {
+  state: 'loading';
+} | {
+  state: 'error';
+  error: string;
+} | {
+  state: 'ready';
+  items: Literal[];
+};
+/** Pure view over list elements.  */
+export declare function ListView({ query, sourcePath }: {
+  query: Query;
+  sourcePath: string;
+}): h.JSX.Element;
+export declare function createListView(init: DataviewInit, query: Query, sourcePath: string): MarkdownRenderChild;
+export declare function createFixedListView(init: DataviewInit, elements: Literal[], sourcePath: string): MarkdownRenderChild;

package/dist/lib/obsidian/@types/Dataview/ui/views/{table-view.d.ts → table-view.d.cts}

@@ -1,8 +1,8 @@
 import type { MarkdownRenderChild } from 'obsidian';
 import type { h } from 'preact';
-import type { Literal } from '../../data-model/value.d.ts';
-import type { Query } from '../../query/query.d.ts';
-import type { DataviewInit } from '../../ui/markdown.d.ts';
+import type { Literal } from '../../data-model/value.d.cjs';
+import type { Query } from '../../query/query.d.cjs';
+import type { DataviewInit } from '../../ui/markdown.d.cjs';
 /** Simple table over headings and corresponding values. */
 export declare function TableGrouping({ headings, values, sourcePath }: {
   headings: string[];

package/dist/lib/obsidian/@types/Dataview/ui/views/table-view.d.mts

@@ -0,0 +1,28 @@
+import type { MarkdownRenderChild } from 'obsidian';
+import type { h } from 'preact';
+import type { Literal } from '../../data-model/value.d.mjs';
+import type { Query } from '../../query/query.d.mjs';
+import type { DataviewInit } from '../../ui/markdown.d.mjs';
+/** Simple table over headings and corresponding values. */
+export declare function TableGrouping({ headings, values, sourcePath }: {
+  headings: string[];
+  values: Literal[][];
+  sourcePath: string;
+}): h.JSX.Element;
+export type TableViewState = {
+  state: 'loading';
+} | {
+  state: 'error';
+  error: string;
+} | {
+  state: 'ready';
+  headings: string[];
+  values: Literal[][];
+};
+/** Pure view over list elements.  */
+export declare function TableView({ query, sourcePath }: {
+  query: Query;
+  sourcePath: string;
+}): h.JSX.Element;
+export declare function createTableView(init: DataviewInit, query: Query, sourcePath: string): MarkdownRenderChild;
+export declare function createFixedTableView(init: DataviewInit, headings: string[], values: Literal[][], sourcePath: string): MarkdownRenderChild;

package/dist/lib/obsidian/@types/Dataview/ui/views/{task-view.d.ts → task-view.d.cts}

@@ -6,10 +6,10 @@ import type { h } from 'preact';
 import type {
   SListItem,
   STask
-} from '../../data-model/serialized/markdown.d.ts';
-import type { Grouping } from '../../data-model/value.d.ts';
-import type { Query } from '../../query/query.d.ts';
-import type { DataviewInit } from '../../ui/markdown.d.ts';
+} from '../../data-model/serialized/markdown.d.cjs';
+import type { Grouping } from '../../data-model/value.d.cjs';
+import type { Query } from '../../query/query.d.cjs';
+import type { DataviewInit } from '../../ui/markdown.d.cjs';
 export type TaskViewState = {
   state: 'loading';
 } | {

package/dist/lib/obsidian/@types/Dataview/ui/views/task-view.d.mts

@@ -0,0 +1,51 @@
+import type {
+  MarkdownRenderChild,
+  Vault
+} from 'obsidian';
+import type { h } from 'preact';
+import type {
+  SListItem,
+  STask
+} from '../../data-model/serialized/markdown.d.mjs';
+import type { Grouping } from '../../data-model/value.d.mjs';
+import type { Query } from '../../query/query.d.mjs';
+import type { DataviewInit } from '../../ui/markdown.d.mjs';
+export type TaskViewState = {
+  state: 'loading';
+} | {
+  state: 'error';
+  error: string;
+} | {
+  state: 'ready';
+  items: Grouping<SListItem>;
+};
+/**
+ * Pure view over (potentially grouped) tasks and list items which allows for checking/unchecking tasks and manipulating
+ * the task view.
+ */
+export declare function TaskView({ query, sourcePath }: {
+  query: Query;
+  sourcePath: string;
+}): h.JSX.Element;
+export declare function createTaskView(init: DataviewInit, query: Query, sourcePath: string): MarkdownRenderChild;
+export declare function createFixedTaskView(init: DataviewInit, items: Grouping<SListItem>, sourcePath: string): MarkdownRenderChild;
+/**
+ * Removes tasks from a list if they are already present by being a child of another task. Fixes child pointers.
+ * Retains original order of input list.
+ */
+export declare function nestItems(raw: SListItem[]): [SListItem[], Set<string>];
+/**
+ * Recursively removes tasks from each subgroup if they are already present by being a child of another task.
+ * Fixes child pointers. Retains original order of input list.
+ */
+export declare function nestGroups(raw: Grouping<SListItem>): Grouping<SListItem>;
+/** Set the task completion key on check. */
+export declare function setTaskCompletion(
+  originalText: string,
+  useEmojiShorthand: boolean,
+  completionKey: string,
+  completionDateFormat: string,
+  complete: boolean
+): string;
+/** Rewrite a task with the given completion status and new text. */
+export declare function rewriteTask(vault: Vault, task: STask, desiredStatus: string, desiredText?: string): Promise<void>;

package/dist/lib/obsidian/@types/Dataview/util/hash.d.mts

@@ -0,0 +1 @@
+export declare function cyrb53(str: string, seed?: number): number;

package/dist/lib/obsidian/@types/Dataview/util/locale.d.mts

@@ -0,0 +1,2 @@
+/** Test-environment-friendly function which fetches the current system locale. */
+export declare function currentLocale(): string;

package/dist/lib/obsidian/@types/Dataview/util/{media.d.ts → media.d.cts}

@@ -1,4 +1,4 @@
-import type { Link } from '../data-model/value.d.ts';
+import type { Link } from '../data-model/value.d.cjs';
 export declare const IMAGE_EXTENSIONS: Readonly<Set<string>>;
 /** Determines if the given link points to an embedded image. */
 export declare function isImageEmbed(link: Link): boolean;

package/dist/lib/obsidian/@types/Dataview/util/media.d.mts

@@ -0,0 +1,6 @@
+import type { Link } from '../data-model/value.d.mjs';
+export declare const IMAGE_EXTENSIONS: Readonly<Set<string>>;
+/** Determines if the given link points to an embedded image. */
+export declare function isImageEmbed(link: Link): boolean;
+/** Extract text of the form 'WxH' or 'W' from the display of a link. */
+export declare function extractImageDimensions(link: Link): [number, number] | [number] | undefined;

package/dist/lib/obsidian/@types/Dataview/util/{normalize.d.ts → normalize.d.cts}

@@ -2,8 +2,8 @@ import type {
   DateTime,
   Duration
 } from 'luxon';
-import type { Result } from '../api/result.d.ts';
-import type { QuerySettings } from '../settings.d.ts';
+import type { Result } from '../api/result.d.cjs';
+import type { QuerySettings } from '../settings.d.cjs';
 /** Normalize a duration to all of the proper units. */
 export declare function normalizeDuration(dur: Duration): Duration;
 /** Strip the time components of a date time object. */

package/dist/lib/obsidian/@types/Dataview/util/normalize.d.mts

@@ -0,0 +1,44 @@
+import type {
+  DateTime,
+  Duration
+} from 'luxon';
+import type { Result } from '../api/result.d.mjs';
+import type { QuerySettings } from '../settings.d.mjs';
+/** Normalize a duration to all of the proper units. */
+export declare function normalizeDuration(dur: Duration): Duration;
+/** Strip the time components of a date time object. */
+export declare function stripTime(dt: DateTime): DateTime;
+/** Try to extract a YYYYMMDD date from a string. */
+export declare function extractDate(str: string): DateTime | undefined;
+/** Get the folder containing the given path (i.e., like computing 'path/..'). */
+export declare function getParentFolder(path: string): string;
+/** Get the file name for the file referenced in the given path, by stripping the parent folders. */
+export declare function getFileName(path: string): string;
+/** Get the "title" for a file, by stripping other parts of the path as well as the extension. */
+export declare function getFileTitle(path: string): string;
+/** Get the extension of a file from the file path. */
+export declare function getExtension(path: string): string;
+/** Parse all subtags out of the given tag. I.e., #hello/i/am would yield [#hello/i/am, #hello/i, #hello]. */
+export declare function extractSubtags(tag: string): string[];
+/** Try calling the given function; on failure, return the error message.  */
+export declare function tryOrPropogate<T>(func: () => Result<T, string>): Result<T, string>;
+/** Try asynchronously calling the given function; on failure, return the error message. */
+export declare function asyncTryOrPropogate<T>(func: () => Promise<Result<T, string>>): Promise<Result<T, string>>;
+/**
+ * Escape regex characters in a string.
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions.
+ */
+export declare function escapeRegex(str: string): string;
+/** Convert an arbitrary variable name into something JS/query friendly. */
+export declare function canonicalizeVarName(name: string): string;
+/**
+ * Normalizes the text in a header to be something that is actually linkable to. This mimics
+ * how Obsidian does it's normalization, collapsing repeated spaces and stripping out control characters.
+ */
+export declare function normalizeHeaderForLink(header: string): string;
+/** Render a DateTime in a minimal format to save space. */
+export declare function renderMinimalDate(time: DateTime, settings: QuerySettings, locale: string): string;
+/** Render a duration in a minimal format to save space. */
+export declare function renderMinimalDuration(dur: Duration): string;
+/** Determine if two sets are equal in contents. */
+export declare function setsEqual<T>(first: Set<T>, second: Set<T>): boolean;

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

@@ -0,0 +1,30 @@
+/**
+ * @packageDocumentation App
+ * Provides a utility to retrieve the Obsidian `App` instance.
+ */
+import type { App } from 'obsidian';
+/**
+ * Wrapper type for storing shared state in the Obsidian app.
+ */
+export declare class ValueWrapper<T> {
+    value: T;
+    constructor(value: T);
+}
+/**
+ * Retrieves the Obsidian `App` instance.
+ *
+ * @returns The `App` instance.
+ * @throws Will throw an error if the `App` instance cannot be found.
+ *
+ * @see {@link https://github.com/mnaoumov/obsidian-codescript-toolkit?tab=readme-ov-file#obsidianapp-module}
+ */
+export declare function getApp(): App;
+/**
+ * Retrieves or creates a shared state wrapper object for a given key in the Obsidian app.
+ *
+ * @param app - The Obsidian app instance.
+ * @param key - The key to store or retrieve the shared state.
+ * @param defaultValue - The default value to use if the shared state does not exist.
+ * @returns The ValueWrapper object that stores the shared state.
+ */
+export declare function getObsidianDevUtilsState<T>(app: App, key: string, defaultValue: T): ValueWrapper<T>;

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

@@ -3,7 +3,7 @@
  * Provides utility functions for working with attachment paths.
  */
 import type { App, TFile } from 'obsidian';
-import type { PathOrFile } from './FileSystem.ts';
+import type { PathOrFile } from './FileSystem.cjs';
 /**
  * Is overridden wrapper.
  */

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

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

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

@@ -2,8 +2,8 @@
  * @packageDocumentation Backlink
  * Provides utility functions for working with backlinks.
  */
-import type { DataviewInlineApi } from './Dataview.ts';
-import type { PathOrAbstractFile, PathOrFile } from './FileSystem.ts';
+import type { DataviewInlineApi } from './Dataview.cjs';
+import type { PathOrAbstractFile, PathOrFile } from './FileSystem.cjs';
 /**
  * Options for rendering delayed backlinks for a folder.
  */

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

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

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

@@ -2,8 +2,8 @@
  * @packageDocumentation Callout
  * This module provides utility functions for rendering callouts in Dataview.
  */
-import type { ValueProvider } from '../ValueProvider.ts';
-import type { DataviewInlineApi } from './Dataview.ts';
+import type { ValueProvider } from '../ValueProvider.cjs';
+import type { DataviewInlineApi } from './Dataview.cjs';
 /**
  * Enum representing the mode of a callout.
  */

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

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

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

@@ -2,7 +2,7 @@
  * @packageDocumentation DateComponent
  * Contains a component that displays and edits a date.
  */
-import { TypedRangeTextComponent } from './TypedRangeTextComponent.ts';
+import { TypedRangeTextComponent } from './TypedRangeTextComponent.cjs';
 /**
  * A component that displays and edits a date.
  *

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

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

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

@@ -2,7 +2,7 @@
  * @packageDocumentation DateTimeComponent
  * Contains a component that displays and edits a date and time.
  */
-import { TypedRangeTextComponent } from './TypedRangeTextComponent.ts';
+import { TypedRangeTextComponent } from './TypedRangeTextComponent.cjs';
 /**
  * A component that displays and edits a date and time.
  *

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

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

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

@@ -2,7 +2,7 @@
  * @packageDocumentation EmailComponent
  * Contains a component that displays and edits an email address.
  */
-import { TypedTextComponent } from './TypedTextComponent.ts';
+import { TypedTextComponent } from './TypedTextComponent.cjs';
 /**
  * A component that displays and edits an email address.
  *

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

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

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

@@ -2,7 +2,7 @@
  * @packageDocumentation FileComponent
  * Contains a component that displays and edits a file.
  */
-import { TypedTextComponent } from './TypedTextComponent.ts';
+import { TypedTextComponent } from './TypedTextComponent.cjs';
 /**
  * A component that displays and edits a file.
  *