obsidian-dev-utils 101.4.0 → 101.5.0

package/dist/lib/esm/obsidian/link.d.mts

@@ -73,6 +73,18 @@ export interface ConvertLinkParams {
      * An Obsidian app instance.
      */
     readonly app: App;
+    /**
+     * Whether to allow an empty alias for embeds.
+     *
+     * Applicable only if the result link style is {@link LinkStyle.Markdown}.
+     *
+     * If `true`: `![](foo.png)`.
+     *
+     * If `false`: `![foo](foo.png)`.
+     *
+     * @default `true`
+     */
+    readonly isEmptyEmbedAliasAllowed?: boolean;
     /**
      * A reference for the link.
      */
@@ -93,12 +105,72 @@ export interface ConvertLinkParams {
      * An old path of the link.
      */
     readonly oldSourcePathOrFile?: PathOrFile;
+    /**
+     * Whether to escape the alias.
+     *
+     * Applicable only if the result link style is {@link LinkStyle.Markdown}.
+     *
+     * If `true`: `[\*\*alias\*\*](link.md)`.
+     *
+     * If `false`: `[**alias**](link.md)`.
+     *
+     * @default `false`
+     */
+    readonly shouldEscapeAlias?: boolean;
+    /**
+     * Whether to include the attachment extension in the embed alias.
+     *
+     * Applicable only if {@link isEmptyEmbedAliasAllowed} is `false`.
+     *
+     * If `true`: `[foo.png](foo.png)`.
+     *
+     * If `false`: `[foo](foo.png)`.
+     *
+     * @default `false`
+     */
+    readonly shouldIncludeAttachmentExtensionToEmbedAlias?: boolean;
     /**
      * Whether to update file name alias.
      *
      * @default `true`
      */
     readonly shouldUpdateFileNameAlias?: boolean;
+    /**
+     * Indicates if the link should use angle brackets.
+     *
+     * Applicable only if {@link linkStyle} is {@link LinkStyle.Markdown}.
+     *
+     * If `true`: `[alias](<path with spaces.md>)`.
+     *
+     * If `false`: `[alias](path%20with%20spaces.md)`.
+     *
+     * @default `false`
+     */
+    readonly shouldUseAngleBrackets?: boolean;
+    /**
+     * Indicates if the link should use a leading dot.
+     *
+     * Applicable only if {@link linkPathStyle} is {@link LinkPathStyle.RelativePathToTheSource}.
+     *
+     * If `true`: `[[./relative/path/to/target]]`
+     *
+     * If `false`: `[[relative/path/to/target]]`
+     *
+     * @default `false`
+     */
+    readonly shouldUseLeadingDotForRelativePaths?: boolean;
+    /**
+     * Indicates if the link should use a leading slash.
+     *
+     * Applicable only if {@link linkPathStyle} is {@link LinkPathStyle.AbsolutePathInVault}.
+     *
+     * If `true`: `[[/absolute/path/to/target]]`
+     *
+     * If `false`: `[[absolute/path/to/target]]`
+     *
+     * @default `false`
+     */
+    readonly shouldUseLeadingSlashForAbsolutePaths?: boolean;
 }
 /**
  * Options for {@link editBacklinks}.
@@ -385,7 +457,7 @@ export interface GenerateMarkdownLinkParams {
     /**
      * Indicates if the link should use a leading dot.
      *
-     * Applicable only if {@link linkPathStyle} is {@link LinkPathStyle.RelativePathToSource}.
+     * Applicable only if {@link linkPathStyle} is {@link LinkPathStyle.RelativePathToTheSource}.
      *
      * If `true`: `[[./relative/path/to/target]]`
      *
@@ -561,6 +633,18 @@ export interface UpdateLinkParams {
      * An Obsidian app instance.
      */
     readonly app: App;
+    /**
+     * Whether to allow an empty alias for embeds.
+     *
+     * Applicable only if the result link style is {@link LinkStyle.Markdown}.
+     *
+     * If `true`: `![](foo.png)`.
+     *
+     * If `false`: `![foo](foo.png)`.
+     *
+     * @default `true`
+     */
+    readonly isEmptyEmbedAliasAllowed?: boolean;
     /**
      * A reference for the link.
      */
@@ -589,12 +673,72 @@ export interface UpdateLinkParams {
      * An old path of the file.
      */
     readonly oldTargetPathOrFile?: PathOrFile;
+    /**
+     * Whether to escape the alias.
+     *
+     * Applicable only if the result link style is {@link LinkStyle.Markdown}.
+     *
+     * If `true`: `[\*\*alias\*\*](link.md)`.
+     *
+     * If `false`: `[**alias**](link.md)`.
+     *
+     * @default `false`
+     */
+    readonly shouldEscapeAlias?: boolean;
+    /**
+     * Whether to include the attachment extension in the embed alias.
+     *
+     * Applicable only if {@link isEmptyEmbedAliasAllowed} is `false`.
+     *
+     * If `true`: `[foo.png](foo.png)`.
+     *
+     * If `false`: `[foo](foo.png)`.
+     *
+     * @default `false`
+     */
+    readonly shouldIncludeAttachmentExtensionToEmbedAlias?: boolean;
     /**
      * Whether to update file name alias.
      *
      * @default `true`
      */
     readonly shouldUpdateFileNameAlias?: boolean;
+    /**
+     * Indicates if the link should use angle brackets.
+     *
+     * Applicable only if {@link linkStyle} is {@link LinkStyle.Markdown}.
+     *
+     * If `true`: `[alias](<path with spaces.md>)`.
+     *
+     * If `false`: `[alias](path%20with%20spaces.md)`.
+     *
+     * @default `false`
+     */
+    readonly shouldUseAngleBrackets?: boolean;
+    /**
+     * Indicates if the link should use a leading dot.
+     *
+     * Applicable only if {@link linkPathStyle} is {@link LinkPathStyle.RelativePathToTheSource}.
+     *
+     * If `true`: `[[./relative/path/to/target]]`
+     *
+     * If `false`: `[[relative/path/to/target]]`
+     *
+     * @default `false`
+     */
+    readonly shouldUseLeadingDotForRelativePaths?: boolean;
+    /**
+     * Indicates if the link should use a leading slash.
+     *
+     * Applicable only if {@link linkPathStyle} is {@link LinkPathStyle.AbsolutePathInVault}.
+     *
+     * If `true`: `[[/absolute/path/to/target]]`
+     *
+     * If `false`: `[[absolute/path/to/target]]`
+     *
+     * @default `false`
+     */
+    readonly shouldUseLeadingSlashForAbsolutePaths?: boolean;
 }
 /**
  * Params for {@link updateLinksInFile}.
@@ -604,6 +748,18 @@ export interface UpdateLinksInFileParams extends ProcessOptions {
      * An Obsidian app instance.
      */
     readonly app: App;
+    /**
+     * Whether to allow an empty alias for embeds.
+     *
+     * Applicable only if the result link style is {@link LinkStyle.Markdown}.
+     *
+     * If `true`: `![](foo.png)`.
+     *
+     * If `false`: `![foo](foo.png)`.
+     *
+     * @default `true`
+     */
+    readonly isEmptyEmbedAliasAllowed?: boolean;
     /**
      * A style of the link path.
      */
@@ -620,6 +776,30 @@ export interface UpdateLinksInFileParams extends ProcessOptions {
      * An old path of the file.
      */
     readonly oldSourcePathOrFile?: PathOrFile;
+    /**
+     * Whether to escape the alias.
+     *
+     * Applicable only if the result link style is {@link LinkStyle.Markdown}.
+     *
+     * If `true`: `[\*\*alias\*\*](link.md)`.
+     *
+     * If `false`: `[**alias**](link.md)`.
+     *
+     * @default `false`
+     */
+    readonly shouldEscapeAlias?: boolean;
+    /**
+     * Whether to include the attachment extension in the embed alias.
+     *
+     * Applicable only if {@link isEmptyEmbedAliasAllowed} is `false`.
+     *
+     * If `true`: `[foo.png](foo.png)`.
+     *
+     * If `false`: `[foo](foo.png)`.
+     *
+     * @default `false`
+     */
+    readonly shouldIncludeAttachmentExtensionToEmbedAlias?: boolean;
     /**
      * Whether to update only embedded links.
      */
@@ -630,6 +810,42 @@ export interface UpdateLinksInFileParams extends ProcessOptions {
      * @default `true`
      */
     readonly shouldUpdateFileNameAlias?: boolean;
+    /**
+     * Indicates if the link should use angle brackets.
+     *
+     * Applicable only if {@link linkStyle} is {@link LinkStyle.Markdown}.
+     *
+     * If `true`: `[alias](<path with spaces.md>)`.
+     *
+     * If `false`: `[alias](path%20with%20spaces.md)`.
+     *
+     * @default `false`
+     */
+    readonly shouldUseAngleBrackets?: boolean;
+    /**
+     * Indicates if the link should use a leading dot.
+     *
+     * Applicable only if {@link linkPathStyle} is {@link LinkPathStyle.RelativePathToTheSource}.
+     *
+     * If `true`: `[[./relative/path/to/target]]`
+     *
+     * If `false`: `[[relative/path/to/target]]`
+     *
+     * @default `false`
+     */
+    readonly shouldUseLeadingDotForRelativePaths?: boolean;
+    /**
+     * Indicates if the link should use a leading slash.
+     *
+     * Applicable only if {@link linkPathStyle} is {@link LinkPathStyle.AbsolutePathInVault}.
+     *
+     * If `true`: `[[/absolute/path/to/target]]`
+     *
+     * If `false`: `[[absolute/path/to/target]]`
+     *
+     * @default `false`
+     */
+    readonly shouldUseLeadingSlashForAbsolutePaths?: boolean;
 }
 /**
  * Params for {@link updateLinksInContent}.
@@ -643,6 +859,18 @@ interface UpdateLinksInContentParams {
      * A content to update the links in.
      */
     readonly content: string;
+    /**
+     * Whether to allow an empty alias for embeds.
+     *
+     * Applicable only if the result link style is {@link LinkStyle.Markdown}.
+     *
+     * If `true`: `![](foo.png)`.
+     *
+     * If `false`: `![foo](foo.png)`.
+     *
+     * @default `true`
+     */
+    readonly isEmptyEmbedAliasAllowed?: boolean;
     /**
      * A style of the link path.
      */
@@ -659,6 +887,30 @@ interface UpdateLinksInContentParams {
      * An old source path or file.
      */
     readonly oldSourcePathOrFile?: PathOrFile;
+    /**
+     * Whether to escape the alias.
+     *
+     * Applicable only if the result link style is {@link LinkStyle.Markdown}.
+     *
+     * If `true`: `[\*\*alias\*\*](link.md)`.
+     *
+     * If `false`: `[**alias**](link.md)`.
+     *
+     * @default `false`
+     */
+    readonly shouldEscapeAlias?: boolean;
+    /**
+     * Whether to include the attachment extension in the embed alias.
+     *
+     * Applicable only if {@link isEmptyEmbedAliasAllowed} is `false`.
+     *
+     * If `true`: `[foo.png](foo.png)`.
+     *
+     * If `false`: `[foo](foo.png)`.
+     *
+     * @default `false`
+     */
+    readonly shouldIncludeAttachmentExtensionToEmbedAlias?: boolean;
     /**
      * Whether to update only embedded links.
      */
@@ -669,6 +921,42 @@ interface UpdateLinksInContentParams {
      * @default `true`
      */
     readonly shouldUpdateFileNameAlias?: boolean;
+    /**
+     * Indicates if the link should use angle brackets.
+     *
+     * Applicable only if {@link linkStyle} is {@link LinkStyle.Markdown}.
+     *
+     * If `true`: `[alias](<path with spaces.md>)`.
+     *
+     * If `false`: `[alias](path%20with%20spaces.md)`.
+     *
+     * @default `false`
+     */
+    readonly shouldUseAngleBrackets?: boolean;
+    /**
+     * Indicates if the link should use a leading dot.
+     *
+     * Applicable only if {@link linkPathStyle} is {@link LinkPathStyle.RelativePathToTheSource}.
+     *
+     * If `true`: `[[./relative/path/to/target]]`
+     *
+     * If `false`: `[[relative/path/to/target]]`
+     *
+     * @default `false`
+     */
+    readonly shouldUseLeadingDotForRelativePaths?: boolean;
+    /**
+     * Indicates if the link should use a leading slash.
+     *
+     * Applicable only if {@link linkPathStyle} is {@link LinkPathStyle.AbsolutePathInVault}.
+     *
+     * If `true`: `[[/absolute/path/to/target]]`
+     *
+     * If `false`: `[[absolute/path/to/target]]`
+     *
+     * @default `false`
+     */
+    readonly shouldUseLeadingSlashForAbsolutePaths?: boolean;
 }
 /**
  * Converts a link to a new path.