obsidian-dev-utils 19.0.0 → 19.1.0

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

@@ -1,185 +1 @@
-/**
- * @packageDocumentation FileSystem
- * This module provides utility functions for working with TAbstractFile, TFile, and TFolder instances in Obsidian.
- */
-import { App, TAbstractFile, TFile, TFolder } from 'obsidian';
-/**
- * The file extension for Markdown files.
- */
-export declare const MARKDOWN_FILE_EXTENSION = "md";
-/**
- * Represents the file extension for canvas files.
- */
-export declare const CANVAS_FILE_EXTENSION = "canvas";
-/**
- * Represents a path or an instance of TAbstractFile.
- */
-export type PathOrAbstractFile = string | TAbstractFile;
-/**
- * Represents a path or a file.
- */
-export type PathOrFile = string | TFile;
-/**
- * Represents a path or an instance of TFolder.
- */
-export type PathOrFolder = string | TFolder;
-/**
- * Checks if the given path or file has the specified extension.
- *
- * @param app - The Obsidian App instance.
- * @param pathOrFile - The path or abstract file to check.
- * @param extension - The extension to compare against.
- * @returns Returns `true` if the path or file has the specified extension, `false` otherwise.
- */
-export declare function checkExtension(app: App, pathOrFile: null | PathOrAbstractFile, extension: string): boolean;
-/**
- * Retrieves the TAbstractFile object for the given path or abstract file.
- *
- * @param app - The App instance.
- * @param pathOrFile - The path or abstract file to retrieve the TAbstractFile for.
- * @param isCaseInsensitive - Specifies whether to perform a case-insensitive search. Default is `false`.
- * @returns The TAbstractFile object.
- * @throws Error if the abstract file is not found.
- */
-export declare function getAbstractFile(app: App, pathOrFile: PathOrAbstractFile, isCaseInsensitive?: boolean): TAbstractFile;
-/**
- * Retrieves an instance of TAbstractFile or null based on the provided path or abstract file.
- *
- * @param app - The application instance.
- * @param pathOrFile - The path or abstract file to retrieve.
- * @param isCaseInsensitive - Specifies whether to perform a case-insensitive search. Default is `false`.
- * @returns The instance of TAbstractFile if found, otherwise null.
- */
-export declare function getAbstractFileOrNull(app: App, pathOrFile: null | PathOrAbstractFile, isCaseInsensitive?: boolean): null | TAbstractFile;
-/**
- * Retrieves a TFile object based on the provided path or file.
- *
- * @param app - The Obsidian App instance.
- * @param pathOrFile - The path or file to retrieve the TFile object for.
- * @param shouldIncludeNonExisting - Whether to include a non-existing file.
- *  If `true`, a new TFile object is created for the provided path.
- *  If `false`, an error is thrown if the file is not found.
- * @param isCaseInsensitive - Specifies whether to perform a case-insensitive search. Default is `false`.
- * @returns The TFile object corresponding to the provided path or file.
- * @throws Error if the file is not found.
- */
-export declare function getFile(app: App, pathOrFile: PathOrFile, shouldIncludeNonExisting?: boolean, isCaseInsensitive?: boolean): TFile;
-/**
- * Retrieves a TFile object based on the provided path or file.
- * If the provided argument is already a TFile object, it is returned as is.
- * Otherwise, the function uses the app's vault to retrieve the TFile object by its path.
- * @param app - The Obsidian App instance.
- * @param pathOrFile - The path or TFile object.
- * @param isCaseInsensitive - Specifies whether to perform a case-insensitive search. Default is `false`.
- * @returns The TFile object if found, otherwise null.
- */
-export declare function getFileOrNull(app: App, pathOrFile: null | PathOrFile, isCaseInsensitive?: boolean): null | TFile;
-/**
- * Retrieves a TFolder object based on the provided app and pathOrFolder.
- *
- * @param app - The Obsidian app instance.
- * @param pathOrFolder - The path or folder identifier.
- * @param shouldIncludeNonExisting - Whether to allow the folder to not exist.
- *  If `true`, a new TFolder object is created for the provided path.
- *  If `false`, an error is thrown if the folder is not found.
- * @param isCaseInsensitive - Specifies whether to perform a case-insensitive search. Default is `false`.
- * @returns The retrieved TFolder object.
- * @throws If the folder is not found.
- */
-export declare function getFolder(app: App, pathOrFolder: PathOrFolder, shouldIncludeNonExisting?: boolean, isCaseInsensitive?: boolean): TFolder;
-/**
- * Retrieves a TFolder object or null based on the provided path or folder.
- *
- * @param app - The Obsidian application instance.
- * @param pathOrFolder - The path or folder to retrieve the TFolder from.
- * @param isCaseInsensitive - Specifies whether to perform a case-insensitive search. Default is `false`.
- * @returns The TFolder object if found, otherwise null.
- */
-export declare function getFolderOrNull(app: App, pathOrFolder: null | PathOrFolder, isCaseInsensitive?: boolean): null | TFolder;
-/**
- * Retrieves an array of TFile objects representing the markdown files within a specified folder or path.
- *
- * @param app - The Obsidian App instance.
- * @param pathOrFolder - The path or folder to retrieve the markdown files from.
- * @param isRecursive - Optional. Specifies whether to recursively search for markdown files within subfolders. Default is false.
- * @returns An array of TFile objects representing the markdown files.
- */
-export declare function getMarkdownFiles(app: App, pathOrFolder: PathOrFolder, isRecursive?: boolean): TFile[];
-/**
- * Retrieves the TFile object for the given path or creates a new one if it does not exist.
- *
- * @param app - The Obsidian App instance.
- * @param path - The path of the file to retrieve or create.
- * @returns The TFile object representing the file
- */
-export declare function getOrCreateFile(app: App, path: string): Promise<TFile>;
-/**
- * Retrieves the TFolder object for the given path or creates a new one if it does not exist.
- *
- * @param app - The Obsidian App instance.
- * @param path - The path of the folder to retrieve or create.
- * @returns The TFolder object representing the folder.
- */
-export declare function getOrCreateFolder(app: App, path: string): Promise<TFolder>;
-/**
- * Returns the path of the given `pathOrFile`.
- *
- * @param app - The Obsidian App instance.
- * @param pathOrFile - The path or abstract file.
- * @returns The path of the `pathOrFile`.
- */
-export declare function getPath(app: App, pathOrFile: PathOrAbstractFile): string;
-/**
- * Checks if the given file is an instance of TAbstractFile.
- *
- * @param file - The file to check.
- * @returns A boolean indicating whether the file is an instance of TAbstractFile.
- */
-export declare function isAbstractFile(file: unknown): file is TAbstractFile;
-/**
- * Checks if the given file is a canvas file.
- *
- * @param app - The Obsidian App instance.
- * @param pathOrFile - The path or file to check.
- * @returns A boolean indicating whether the file is a canvas file or not.
- */
-export declare function isCanvasFile(app: App, pathOrFile: null | PathOrAbstractFile): boolean;
-/**
- * Checks if the given file is an instance of TFile.
- *
- * @param file - The file to check.
- * @returns A boolean indicating whether the file is an instance of TFile.
- */
-export declare function isFile(file: unknown): file is TFile;
-/**
- * Checks if the given file is a folder.
- *
- * @param file - The file to check.
- * @returns `true` if the file is a folder, `false` otherwise.
- */
-export declare function isFolder(file: unknown): file is TFolder;
-/**
- * Checks if the given file is a Markdown file.
- *
- * @param app - The Obsidian App instance.
- * @param pathOrFile - The path or file to check.
- * @returns A boolean indicating whether the file is a Markdown file.
- */
-export declare function isMarkdownFile(app: App, pathOrFile: null | PathOrAbstractFile): boolean;
-/**
- * Checks if the given file is a note.
- *
- * @param app - The Obsidian App instance.
- * @param pathOrFile - The path or file to check.
- * @returns A boolean indicating whether the file is a note.
- */
-export declare function isNote(app: App, pathOrFile: null | PathOrAbstractFile): boolean;
-/**
- * Trims the markdown extension from the file path if the file is a markdown file.
- * If the file is not a markdown file, the original file path is returned.
- *
- * @param app - The Obsidian App instance.
- * @param file - The file to trim the markdown extension from.
- * @returns The file path with the markdown extension trimmed.
- */
-export declare function trimMarkdownExtension(app: App, file: TAbstractFile): string;
+export * from './FileSystem.cjs';

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

@@ -1,69 +1 @@
-/**
- * @packageDocumentation Frontmatter
- * This module provides utility functions for processing and managing YAML front matter in Obsidian notes.
- */
-/**
- * Represents the combined front matter of a document.
- * It is a union of custom front matter, Obsidian front matter, and additional properties.
- * @typeParam CustomFrontmatter - The type of custom front matter.
- */
-export type CombinedFrontmatter<CustomFrontmatter> = CustomFrontmatter & ObsidianFrontmatter & Record<string, unknown>;
-/**
- * Represents the front matter of an Obsidian file.
- * @see {@link https://help.obsidian.md/Editing+and+formatting/Properties#Default+properties}
- */
-export interface ObsidianFrontmatter {
-    /**
-     * An array of aliases for the note.
-     */
-    aliases?: string[];
-    /**
-     * An array of CSS classes to apply to the note.
-     */
-    cssclasses?: string[];
-    /**
-     * An array of tags for the note.
-     */
-    tags?: string[];
-}
-/**
- * Represents the front matter for publishing in Obsidian.
- * @see {@link https://help.obsidian.md/Editing+and+formatting/Properties#Properties+for+Obsidian+Publish}
- */
-export interface ObsidianPublishFrontmatter {
-    /**
-     * The cover image for the note.
-     */
-    cover?: string;
-    /**
-     * The description for the note.
-     */
-    description?: string;
-    /**
-     * The image for the note.
-     */
-    image?: string;
-    /**
-     * The permanent link for the note.
-     */
-    permalink?: string;
-    /**
-     * Whether the note is published.
-     */
-    publish?: boolean;
-}
-/**
- * Parses the front matter of a given content string.
- *
- * @param content - The content string to parse.
- * @returns The parsed front matter.
- */
-export declare function parseFrontmatter<CustomFrontmatter = unknown>(content: string): CombinedFrontmatter<CustomFrontmatter>;
-/**
- * Sets the front matter of a given content string.
- *
- * @param content - The content string to set the front matter in.
- * @param newFrontmatter - The new front matter to set.
- * @returns The new content string with the front matter set.
- */
-export declare function setFrontmatter(content: string, newFrontmatter: object): string;
+export * from './Frontmatter.cjs';

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

@@ -1,366 +1 @@
-/**
- * @packageDocumentation Link
- * This module provides utilities for handling and updating links within Obsidian vaults. It includes
- * functions to split paths, update links in files, and generate markdown links with various options.
- * The functions integrate with Obsidian's API to ensure that links are managed correctly within the vault.
- */
-import type { App, Reference, TFile } from 'obsidian';
-import type { MaybePromise } from '../Async.mjs';
-import type { PathOrFile } from './FileSystem.mjs';
-import type { ProcessOptions } from './Vault.mjs';
-/**
- * Options for converting a link.
- */
-export interface ConvertLinkOptions {
-    /**
-     * The Obsidian app instance.
-     */
-    app: App;
-    /**
-     * The reference for the link.
-     */
-    link: Reference;
-    /**
-     * The source file containing the link.
-     */
-    newSourcePathOrFile: PathOrFile;
-    /**
-     * The old path of the link.
-     */
-    oldSourcePathOrFile?: PathOrFile;
-    /**
-     * Whether to force markdown links.
-     */
-    shouldForceMarkdownLinks?: boolean;
-    /**
-     * Whether to update filename alias. Defaults to `true`.
-     */
-    shouldUpdateFilenameAlias?: boolean;
-}
-/**
- * Wrapper for default options for generating markdown links.
- */
-export interface GenerateMarkdownLinkDefaultOptionsWrapper {
-    /**
-     * The default options for generating markdown links.
-     */
-    defaultOptionsFn: () => Partial<GenerateMarkdownLinkOptions>;
-}
-/**
- * Options for generating a markdown link.
- */
-export interface GenerateMarkdownLinkOptions {
-    /**
-     * The alias for the link.
-     */
-    alias?: string;
-    /**
-     * The Obsidian app instance.
-     */
-    app: App;
-    /**
-     * Indicates if the link should be embedded. If not provided, it will be inferred based on the file type.
-     */
-    isEmbed?: boolean;
-    /**
-     * Whether to allow an empty alias for embeds. Defaults to `true`.
-     */
-    isEmptyEmbedAliasAllowed?: boolean;
-    /**
-     * Whether to allow non-existing files. If `false` and `pathOrFile` is a non-existing file, an error will be thrown. Defaults to `false`.
-     */
-    isNonExistingFileAllowed?: boolean;
-    /**
-     * Indicates if the link should be a wikilink. If not provided, it will be inferred based on the Obsidian settings.
-     */
-    isWikilink?: boolean;
-    /**
-     * The original link text. If provided, it will be used to infer the values of `isEmbed`, `isWikilink`, `useLeadingDot`, and `useAngleBrackets`.
-     * These inferred values will be overridden by corresponding settings if specified.
-     */
-    originalLink?: string;
-    /**
-     * Indicates if the link should be relative. If not provided or `false`, it will be inferred based on the Obsidian settings.
-     */
-    shouldForceRelativePath?: boolean;
-    /**
-     * Whether to include the attachment extension in the embed alias. Has no effect if `allowEmptyEmbedAlias` is `true`. Defaults to `false`.
-     */
-    shouldIncludeAttachmentExtensionToEmbedAlias?: boolean;
-    /**
-     * Indicates if the link should use angle brackets. Defaults to `false`. Has no effect if `isWikilink` is `true`
-     */
-    shouldUseAngleBrackets?: boolean;
-    /**
-     * Indicates if the link should use a leading dot. Defaults to `false`. Has no effect if `isWikilink` is `true` or `isRelative` is `false`.
-     */
-    shouldUseLeadingDot?: boolean;
-    /**
-     * The source path of the link.
-     */
-    sourcePathOrFile: PathOrFile;
-    /**
-     * The subpath of the link.
-     */
-    subpath?: string;
-    /**
-     * The target path or file.
-     */
-    targetPathOrFile: PathOrFile;
-}
-/**
- * The result of parsing a link.
- */
-export interface ParseLinkResult {
-    /**
-     * The alias of the link.
-     */
-    alias?: string;
-    /**
-     * Indicates if the link has angle brackets.
-     */
-    hasAngleBrackets?: boolean;
-    /**
-     * Indicates if the link is an embed link.
-     */
-    isEmbed: boolean;
-    /**
-     * Indicates if the link is external.
-     */
-    isExternal?: boolean;
-    /**
-     * Indicates if the link is a wikilink.
-     */
-    isWikilink: boolean;
-    /**
-     * The title of the link.
-     */
-    title?: string;
-    /**
-     * The URL of the link.
-     */
-    url: string;
-}
-/**
- * Options for determining if the alias of a link should be reset.
- */
-export interface ShouldResetAliasOptions {
-    /**
-     * The Obsidian app instance.
-     */
-    app: App;
-    /**
-     * The display text of the link.
-     */
-    displayText: string | undefined;
-    /**
-     * Indicates if the link is a wikilink.
-     */
-    isWikilink?: boolean;
-    /**
-     * The source path of the link.
-     */
-    newSourcePathOrFile: PathOrFile;
-    /**
-     * The old source file containing the link.
-     */
-    oldSourcePathOrFile?: PathOrFile;
-    /**
-     * The old target path of the link.
-     */
-    oldTargetPath: PathOrFile;
-    /**
-     * The target path or file.
-     */
-    targetPathOrFile: PathOrFile;
-}
-/**
- * Splits a link into its link path and subpath.
- */
-export interface SplitSubpathResult {
-    /**
-     * The link path.
-     */
-    linkPath: string;
-    /**
-     * The subpath.
-     */
-    subpath: string;
-}
-/**
- * Options for updating a link.
- */
-export interface UpdateLinkOptions {
-    /**
-     * The Obsidian app instance.
-     */
-    app: App;
-    /**
-     * The reference for the link.
-     */
-    link: Reference;
-    /**
-     * The source file containing the link.
-     */
-    newSourcePathOrFile: PathOrFile;
-    /**
-     * The file associated with the link.
-     */
-    newTargetPathOrFile: PathOrFile;
-    /**
-     * The old source file containing the link.
-     */
-    oldSourcePathOrFile?: PathOrFile;
-    /**
-     * The old path of the file.
-     */
-    oldTargetPathOrFile?: PathOrFile;
-    /**
-     * Whether to force markdown links.
-     */
-    shouldForceMarkdownLinks?: boolean;
-    /**
-     * Whether to update filename alias. Defaults to `true`.
-     */
-    shouldUpdateFilenameAlias?: boolean;
-}
-/**
- * Options for updating links in a file.
- */
-export interface UpdateLinksInFileOptions extends ProcessOptions {
-    /**
-     * The obsidian app instance.
-     */
-    app: App;
-    /**
-     * The file to update the links in.
-     */
-    newSourcePathOrFile: PathOrFile;
-    /**
-     * The old path of the file.
-     */
-    oldSourcePathOrFile?: PathOrFile;
-    /**
-     * Whether to force the links to be in Markdown format.
-     */
-    shouldForceMarkdownLinks?: boolean;
-    /**
-     * Whether to update only embedded links.
-     */
-    shouldUpdateEmbedOnlyLinks?: boolean;
-    /**
-     * Whether to update filename alias. Defaults to `true`.
-     */
-    shouldUpdateFilenameAlias?: boolean;
-}
-/**
- * Converts a link to a new path.
- *
- * @param options - The options for converting the link.
- * @returns The converted link.
- */
-export declare function convertLink(options: ConvertLinkOptions): string;
-/**
- * Edits the backlinks for a file or path.
- *
- * @param app - The Obsidian application instance.
- * @param pathOrFile - The path or file to edit the backlinks for.
- * @param linkConverter - The function that converts each link.
- * @param processOptions - Optional options for retrying the operation.
- * @returns A promise that resolves when the backlinks have been edited.
- */
-export declare function editBacklinks(app: App, pathOrFile: PathOrFile, linkConverter: (link: Reference) => MaybePromise<string | void>, processOptions?: ProcessOptions): Promise<void>;
-/**
- * Edits the backlinks for a file or path.
- *
- * @param app - The Obsidian application instance.
- * @param pathOrFile - The path or file to edit the backlinks for.
- * @param linkConverter - The function that converts each link.
- * @param processOptions - Optional options for retrying the operation.
- * @returns A promise that resolves when the backlinks have been edited.
- */
-export declare function editLinks(app: App, pathOrFile: PathOrFile, linkConverter: (link: Reference) => MaybePromise<string | void>, processOptions?: ProcessOptions): Promise<void>;
-/**
- * Extracts the file associated with a link.
- *
- * @param app - The Obsidian application instance.
- * @param link - The reference cache for the link.
- * @param sourcePathOrFile - The source path or file.
- * @returns The file associated with the link, or null if not found.
- */
-export declare function extractLinkFile(app: App, link: Reference, sourcePathOrFile: PathOrFile): null | TFile;
-/**
- * Generates a markdown link based on the provided parameters.
- *
- * @param options - The options for generating the markdown link.
- * @returns The generated markdown link.
- */
-export declare function generateMarkdownLink(options: GenerateMarkdownLinkOptions): string;
-/**
- * Parses a link into its components.
- *
- * @param str - The link to parse.
- * @returns The parsed link.
- */
-export declare function parseLink(str: string): null | ParseLinkResult;
-/**
- * Determines if the alias of a link should be reset.
- *
- * @param options - The options for determining if the alias should be reset.
- * @returns Whether the alias should be reset.
- */
-export declare function shouldResetAlias(options: ShouldResetAliasOptions): boolean;
-/**
- * Splits a link into its link path and subpath.
- *
- * @param link - The link to split.
- * @returns An object containing the link path and subpath.
- */
-export declare function splitSubpath(link: string): SplitSubpathResult;
-/**
- * Tests whether a link uses angle brackets, possibly embed:
- * `[title](<link>)`, `![title](<link>)`.
- *
- * @param link - Link to test
- * @returns Whether the link uses angle brackets
- */
-export declare function testAngleBrackets(link: string): boolean;
-/**
- * Tests whether a link is an embed link:
- * `![[link]]`, `![title](link)`.
- *
- * @param link - Link to test
- * @returns Whether the link is an embed link
- */
-export declare function testEmbed(link: string): boolean;
-/**
- * Tests whether a link has a leading dot, possibly embed:
- * `[[./link]]`, `[title](./link)`, `[title](<./link>)`,
- * `![[./link]]`, `![title](./link)`, `![title](<./link>)`.
- *
- * @param link - Link to test
- * @returns Whether the link has a leading dot
- */
-export declare function testLeadingDot(link: string): boolean;
-/**
- * Tests whether a link is a wikilink, possibly embed:
- * `[[link]]`, `![[link]]`.
- *
- * @param link - Link to test
- * @returns Whether the link is a wikilink
- */
-export declare function testWikilink(link: string): boolean;
-/**
- * Updates a link based on the provided parameters.
- *
- * @param options - The options for updating the link.
- * @returns The updated link.
- */
-export declare function updateLink(options: UpdateLinkOptions): string;
-/**
- * Updates the links in a file based on the provided parameters.
- *
- * @param options - The options for updating the links.
- * @returns A promise that resolves when the links are updated.
- */
-export declare function updateLinksInFile(options: UpdateLinksInFileOptions): Promise<void>;
+export * from './Link.cjs';

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

@@ -1,13 +1 @@
-/**
- * @packageDocumentation Logger
- * Contains utility functions for logging in Obsidian.
- */
-import type { MaybePromise } from '../Async.mjs';
-/**
- * Invokes a function and logs the start, end, and duration of the invocation.
- *
- * @param title - The title of the log.
- * @param fn - The function to invoke.
- * @param stackTrace - Optional stack trace.
- */
-export declare function invokeAsyncAndLog(title: string, fn: () => MaybePromise<void>, stackTrace?: string): Promise<void>;
+export * from './Logger.cjs';

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

@@ -1,36 +1 @@
-/**
- * @packageDocumentation Loop
- * Contains utility functions for looping in Obsidian.
- */
-import type { MaybePromise } from '../Async.mjs';
-/**
- * Options for the loop function.
- */
-export interface LoopOptions<T> {
-    /**
-     * An optional abort signal to cancel the loop.
-     */
-    abortSignal?: AbortSignal;
-    /**
-     * The function to build the notice message for each item.
-     */
-    buildNoticeMessage(item: T, iterationStr: string): string;
-    /**
-     * The items to loop over.
-     */
-    items: T[];
-    /**
-     * The function to process each item.
-     */
-    processItem(item: T): MaybePromise<void>;
-    /**
-     * Whether to continue the loop on error.
-     */
-    shouldContinueOnError?: boolean;
-}
-/**
- * Loops over a list of items and processes each item.
- *
- * @param options - The options for the loop.
- */
-export declare function loop<T>(options: LoopOptions<T>): Promise<void>;
+export * from './Loop.cjs';

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

@@ -1,24 +1 @@
-/**
- * @packageDocumentation Markdown
- * This module provides utility functions for processing Markdown content in Obsidian.
- */
-import { App, Component } from 'obsidian';
-/**
- * Render the markdown and embeds.
- *
- * @param app - The Obsidian app instance.
- * @param markdown - The Markdown string to render.
- * @param el - The HTMLElement to render to.
- * @param sourcePath - The source path to resolve relative links.
- * @param component - The Component instance.
- */
-export declare function fullRender(app: App, markdown: string, el: HTMLElement, sourcePath: string, component: Component): Promise<void>;
-/**
- * Converts Markdown to HTML.
- *
- * @param app - The Obsidian app instance.
- * @param markdown - The Markdown string to convert.
- * @param sourcePath - (optional) The source path to resolve relative links.
- * @returns The HTML string.
- */
-export declare function markdownToHtml(app: App, markdown: string, sourcePath?: string): Promise<string>;
+export * from './Markdown.cjs';