obsidian-dev-utils 4.9.0 → 4.11.0

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

@@ -7,66 +7,6 @@
 import type { App, Reference, TFile } from 'obsidian';
 import type { MaybePromise, RetryOptions } from '../Async.ts';
 import type { PathOrFile } from './FileSystem.ts';
-/**
- * Splits a link into its link path and subpath.
- */
-export interface SplitSubpathResult {
-    /**
-     * The link path.
-     */
-    linkPath: string;
-    /**
-     * The subpath.
-     */
-    subpath: string;
-}
-/**
- * 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;
-/**
- * Options for updating links in a file.
- */
-export interface UpdateLinksInFileOptions {
-    /**
-     * The obsidian app instance.
-     */
-    app: App;
-    /**
-     * Whether to update only embedded links.
-     */
-    embedOnlyLinks?: boolean | undefined;
-    /**
-     * Whether to force the links to be in Markdown format.
-     */
-    forceMarkdownLinks?: boolean | undefined;
-    /**
-     * The old path of the file.
-     */
-    oldPathOrFile?: PathOrFile | undefined;
-    /**
-     * The file to update the links in.
-     */
-    pathOrFile: PathOrFile;
-    /**
-     * A map of old and new paths for renaming links.
-     */
-    renameMap?: Map<string, string> | undefined;
-    /**
-     * Whether to update filename alias. Defaults to `true`.
-     */
-    shouldUpdateFilenameAlias?: boolean | undefined;
-}
-/**
- * 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>;
 /**
  * Options for converting a link.
  */
@@ -101,65 +41,76 @@ export interface ConvertLinkOptions {
     sourcePathOrFile: PathOrFile;
 }
 /**
- * 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;
-/**
- * Extracts the file associated with a link.
- *
- * @param app - The Obsidian application instance.
- * @param link - The reference cache for the link.
- * @param notePathOrFile - The path or file of the note containing the link.
- * @returns The file associated with the link, or null if not found.
+ * Wrapper for default options for generating markdown links.
  */
-export declare function extractLinkFile(app: App, link: Reference, notePathOrFile: PathOrFile): null | TFile;
+export interface GenerateMarkdownLinkDefaultOptionsWrapper {
+    /**
+     * The default options for generating markdown links.
+     */
+    defaultOptionsFn: () => Partial<GenerateMarkdownLinkOptions>;
+}
 /**
- * Options for updating a link.
+ * Options for generating a markdown link.
  */
-export interface UpdateLinkOptions {
+export interface GenerateMarkdownLinkOptions {
+    /**
+     * The alias for the link.
+     */
+    alias?: string | undefined;
+    /**
+     * Whether to allow an empty alias for embeds. Defaults to `true`.
+     */
+    allowEmptyEmbedAlias?: boolean | undefined;
+    /**
+     * Whether to allow non-existing files. If `false` and `pathOrFile` is a non-existing file, an error will be thrown. Defaults to `false`.
+     */
+    allowNonExistingFile?: boolean | undefined;
     /**
      * The Obsidian app instance.
      */
     app: App;
     /**
-     * Whether to force markdown links.
+     * Indicates if the link should be relative. If not provided or `false`, it will be inferred based on the Obsidian settings.
      */
-    forceMarkdownLinks?: boolean | undefined;
+    forceRelativePath?: boolean | undefined;
     /**
-     * The reference for the link.
+     * Whether to include the attachment extension in the embed alias. Has no effect if `allowEmptyEmbedAlias` is `true`. Defaults to `false`.
      */
-    link: Reference;
+    includeAttachmentExtensionToEmbedAlias?: boolean | undefined;
     /**
-     * The old path of the file.
+     * Indicates if the link should be embedded. If not provided, it will be inferred based on the file type.
      */
-    oldPathOrFile?: PathOrFile | undefined;
+    isEmbed?: boolean | undefined;
     /**
-     * The file associated with the link.
+     * Indicates if the link should be a wikilink. If not provided, it will be inferred based on the Obsidian settings.
      */
-    pathOrFile: null | PathOrFile;
+    isWikilink?: boolean | undefined;
     /**
-     * A map of old and new file paths.
-     */
-    renameMap?: Map<string, string> | undefined;
+      * 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 | undefined;
     /**
-     * Whether to update filename alias. Defaults to `true`.
+     * The file to link to.
      */
-    shouldUpdateFilenameAlias?: boolean | undefined;
+    pathOrFile: PathOrFile;
     /**
-     * The source file containing the link.
+     * The source path of the link.
      */
     sourcePathOrFile: PathOrFile;
+    /**
+     * The subpath of the link.
+     */
+    subpath?: string | undefined;
+    /**
+     * Indicates if the link should use angle brackets. Defaults to `false`. Has no effect if `isWikilink` is `true`
+     */
+    useAngleBrackets?: boolean | undefined;
+    /**
+     * Indicates if the link should use a leading dot. Defaults to `false`. Has no effect if `isWikilink` is `true` or `isRelative` is `false`.
+     */
+    useLeadingDot?: boolean | undefined;
 }
-/**
- * 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;
 /**
  * Options for determining if the alias of a link should be reset.
  */
@@ -190,90 +141,105 @@ export interface ShouldResetAliasOptions {
     sourcePathOrFile: PathOrFile;
 }
 /**
- * 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;
-/**
- * Wrapper for default options for generating markdown links.
+ * Splits a link into its link path and subpath.
  */
-export interface GenerateMarkdownLinkDefaultOptionsWrapper {
+export interface SplitSubpathResult {
     /**
-     * The default options for generating markdown links.
+     * The link path.
      */
-    defaultOptionsFn: () => Partial<GenerateMarkdownLinkOptions>;
+    linkPath: string;
+    /**
+     * The subpath.
+     */
+    subpath: string;
 }
 /**
- * Options for generating a markdown link.
+ * Options for updating a link.
  */
-export interface GenerateMarkdownLinkOptions {
+export interface UpdateLinkOptions {
     /**
-     * The alias for the link.
+     * The Obsidian app instance.
      */
-    alias?: string | undefined;
+    app: App;
     /**
-     * Whether to allow an empty alias for embeds. Defaults to `true`.
+     * Whether to force markdown links.
      */
-    allowEmptyEmbedAlias?: boolean | undefined;
+    forceMarkdownLinks?: boolean | undefined;
     /**
-     * Whether to allow non-existing files. If `false` and `pathOrFile` is a non-existing file, an error will be thrown. Defaults to `false`.
+     * The reference for the link.
      */
-    allowNonExistingFile?: boolean | undefined;
+    link: Reference;
     /**
-     * The Obsidian app instance.
+     * The old path of the file.
      */
-    app: App;
+    oldPathOrFile?: PathOrFile | undefined;
     /**
-     * Indicates if the link should be relative. If not provided or `false`, it will be inferred based on the Obsidian settings.
+     * The file associated with the link.
      */
-    forceRelativePath?: boolean | undefined;
+    pathOrFile: null | PathOrFile;
     /**
-     * Whether to include the attachment extension in the embed alias. Has no effect if `allowEmptyEmbedAlias` is `true`. Defaults to `false`.
+     * A map of old and new file paths.
      */
-    includeAttachmentExtensionToEmbedAlias?: boolean | undefined;
+    renameMap?: Map<string, string> | undefined;
     /**
-     * Indicates if the link should be embedded. If not provided, it will be inferred based on the file type.
+     * Whether to update filename alias. Defaults to `true`.
      */
-    isEmbed?: boolean | undefined;
+    shouldUpdateFilenameAlias?: boolean | undefined;
     /**
-     * Indicates if the link should be a wikilink. If not provided, it will be inferred based on the Obsidian settings.
+     * The source file containing the link.
      */
-    isWikilink?: boolean | undefined;
+    sourcePathOrFile: PathOrFile;
+}
+/**
+ * Options for updating links in a file.
+ */
+export interface UpdateLinksInFileOptions {
     /**
-      * 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 | undefined;
+     * The obsidian app instance.
+     */
+    app: App;
     /**
-     * The file to link to.
+     * Whether to update only embedded links.
      */
-    pathOrFile: PathOrFile;
+    embedOnlyLinks?: boolean | undefined;
     /**
-     * The source path of the link.
+     * Whether to force the links to be in Markdown format.
      */
-    sourcePathOrFile: PathOrFile;
+    forceMarkdownLinks?: boolean | undefined;
     /**
-     * The subpath of the link.
+     * The old path of the file.
      */
-    subpath?: string | undefined;
+    oldPathOrFile?: PathOrFile | undefined;
     /**
-     * Indicates if the link should use angle brackets. Defaults to `false`. Has no effect if `isWikilink` is `true`
+     * The file to update the links in.
      */
-    useAngleBrackets?: boolean | undefined;
+    pathOrFile: PathOrFile;
     /**
-     * Indicates if the link should use a leading dot. Defaults to `false`. Has no effect if `isWikilink` is `true` or `isRelative` is `false`.
+     * A map of old and new paths for renaming links.
      */
-    useLeadingDot?: boolean | undefined;
+    renameMap?: Map<string, string> | undefined;
+    /**
+     * Whether to update filename alias. Defaults to `true`.
+     */
+    shouldUpdateFilenameAlias?: boolean | undefined;
 }
 /**
- * Generates a markdown link based on the provided parameters.
+ * Converts a link to a new path.
  *
- * @param options - The options for generating the markdown link.
- * @returns The generated markdown link.
+ * @param options - The options for converting the link.
+ * @returns The converted link.
  */
-export declare function generateMarkdownLink(options: GenerateMarkdownLinkOptions): string;
+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 retryOptions - 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>, retryOptions?: Partial<RetryOptions>): Promise<void>;
 /**
  * Edits the links in the specified file or path using the provided link converter function.
  *
@@ -284,6 +250,44 @@ export declare function generateMarkdownLink(options: GenerateMarkdownLinkOption
  * @returns A promise that resolves when the links have been edited.
  */
 export declare function editLinks(app: App, pathOrFile: PathOrFile, linkConverter: (link: Reference) => MaybePromise<string | void>, retryOptions?: Partial<RetryOptions>): Promise<void>;
+/**
+ * Extracts the file associated with a link.
+ *
+ * @param app - The Obsidian application instance.
+ * @param link - The reference cache for the link.
+ * @param notePathOrFile - The path or file of the note containing the link.
+ * @returns The file associated with the link, or null if not found.
+ */
+export declare function extractLinkFile(app: App, link: Reference, notePathOrFile: 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;
+/**
+ * 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)`.
@@ -292,6 +296,15 @@ export declare function editLinks(app: App, pathOrFile: PathOrFile, linkConverte
  * @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]]`.
@@ -301,19 +314,16 @@ export declare function testEmbed(link: string): boolean;
  */
 export declare function testWikilink(link: string): boolean;
 /**
- * Tests whether a link has a leading dot, possibly embed:
- * `[[./link]]`, `[title](./link)`, `[title](<./link>)`,
- * `![[./link]]`, `![title](./link)`, `![title](<./link>)`.
+ * Updates a link based on the provided parameters.
  *
- * @param link - Link to test
- * @returns Whether the link has a leading dot
+ * @param options - The options for updating the link.
+ * @returns The updated link.
  */
-export declare function testLeadingDot(link: string): boolean;
+export declare function updateLink(options: UpdateLinkOptions): string;
 /**
- * Tests whether a link uses angle brackets, possibly embed:
- * `[title](<link>)`, `![title](<link>)`.
+ * Updates the links in a file based on the provided parameters.
  *
- * @param link - Link to test
- * @returns Whether the link uses angle brackets
+ * @param options - The options for updating the links.
+ * @returns A promise that resolves when the links are updated.
  */
-export declare function testAngleBrackets(link: string): boolean;
+export declare function updateLinksInFile(options: UpdateLinksInFileOptions): Promise<void>;