add new link methods

Author: mProjectsCode

jsEngine/api/API.ts

@@ -126,17 +126,29 @@ export class API {
 
 	/**
 	 * Gets the target file of a link.
-	 * The link must be a valid wiki link with or without the brackets, so `[[file|foo]]` or `file|foo`.
-	 * If the link is not found, this will return undefined.
+	 * This link can be a markdown link or a wiki link.
+	 * If the link target is not found, this will return undefined.
 	 *
 	 * @param link the link to get the target file of.
 	 * @param sourcePath the path of the file that contains the link. This is needed to resolve relative links.
 	 */
-	public getLinkTarget(link: string, sourcePath: string): TFile | undefined {
+	public resolveLinkToTFile(link: string, sourcePath: string): TFile | undefined {
 		validateAPIArgs(z.object({ link: z.string() }), { link });
 
 		const parsedLink = MarkdownLink.fromString(link);
 
 		return parsedLink?.toTFile(this.app, sourcePath);
 	}
+
+	/**
+	 * Parses a markdown link.
+	 * This link can be a markdown link or a wiki link.
+	 *
+	 * @param link the link to parse.
+	 */
+	public parseLink(link: string): MarkdownLink | undefined {
+		validateAPIArgs(z.object({ link: z.string() }), { link });
+
+		return MarkdownLink.fromString(link);
+	}
 }

jsEngine/api/QueryAPI.ts

@@ -44,12 +44,12 @@ export class QueryAPI {
 	 * const paths = engine.query.filesWithMetadata((file, cache, tags) => tags.includes("Foo") ? file.path : undefined);
 	 * ```
 	 */
-	public filesWithMetadata<T>(query: (file: TFile, cache: CachedMetadata | null, tags: string[]) => T | undefined): T[] {
+	public filesWithMetadata<T>(query: (file: TFile, cache: CachedMetadata | undefined, tags: string[], frontmatterTags: string[]) => T | undefined): T[] {
 		validateAPIArgs(
 			z.object({
 				query: z
 					.function()
-					.args(this.apiInstance.validators.tFile, this.apiInstance.validators.cachedMetadata.nullable(), z.string().array())
+					.args(this.apiInstance.validators.tFile, this.apiInstance.validators.cachedMetadata.optional(), z.string().array(), z.string().array())
 					.returns(z.unknown()),
 			}),
 			{ query },
@@ -60,7 +60,64 @@ export class QueryAPI {
 			.map(file => {
 				const cache = this.apiInstance.app.metadataCache.getFileCache(file);
 				const tags = cache ? (getAllTags(cache) ?? []) : [];
-				return query(file, cache, tags);
+				const frontmatterTags = (cache?.frontmatter?.tags as string[] | undefined) ?? [];
+				return query(file, cache ?? undefined, tags, frontmatterTags);
+			})
+			.filter(x => x !== undefined);
+	}
+
+	public outgoingLinks(file: TFile): { file: TFile; cache: CachedMetadata | undefined; tags: string[]; frontmatterTags: string[] }[] {
+		validateAPIArgs(z.object({ file: this.apiInstance.validators.tFile }), { file });
+
+		const metadata = this.apiInstance.app.metadataCache.getFileCache(file);
+		if (!metadata) {
+			return [];
+		}
+
+		const links = metadata.links ?? [];
+		const files = links.map(link => this.apiInstance.app.metadataCache.getFirstLinkpathDest(link.link, file.path)).filter(file => file != null);
+		const uniqueFiles = Array.from(new Set(files));
+
+		return uniqueFiles.map(file => {
+			const metadata = this.apiInstance.app.metadataCache.getFileCache(file);
+			return {
+				file: file,
+				cache: metadata ?? undefined,
+				tags: metadata ? (getAllTags(metadata) ?? []) : [],
+				frontmatterTags: (metadata?.frontmatter?.tags as string[] | undefined) ?? [],
+			};
+		});
+	}
+
+	public incomingLinks(file: TFile): { file: TFile; cache: CachedMetadata | undefined; tags: string[]; frontmatterTags: string[] }[] {
+		validateAPIArgs(z.object({ file: this.apiInstance.validators.tFile }), { file });
+
+		const files = this.apiInstance.app.vault.getMarkdownFiles();
+
+		return files
+			.map(file => {
+				const metadata = this.apiInstance.app.metadataCache.getFileCache(file);
+				if (!metadata) {
+					return undefined;
+				}
+
+				const links = metadata.links ?? [];
+
+				if (
+					links.some(link => {
+						const linkFile = this.apiInstance.app.metadataCache.getFirstLinkpathDest(link.link, file.path);
+						return linkFile?.path === file.path;
+					})
+				) {
+					return {
+						file: file,
+						cache: metadata,
+						tags: getAllTags(metadata) ?? [],
+						frontmatterTags: (metadata?.frontmatter?.tags as string[] | undefined) ?? [],
+					};
+				}
+
+				return undefined;
 			})
 			.filter(x => x !== undefined);
 	}

jsEngine/utils/Link.ts

@@ -2,14 +2,23 @@ import type { Parser } from '@lemons_dev/parsinom/lib/Parser';
 import { P } from '@lemons_dev/parsinom/lib/ParsiNOM';
 import type { App, TFile } from 'obsidian';
 
-export const P_FilePath: Parser<string> = P.manyNotOf('{}[]#^|:?').box('file path');
+/**
+ * @internal
+ */
+const P_FilePath: Parser<string> = P.manyNotOf('{}[]#^|:?').box('file path');
 
+/**
+ * @internal
+ */
 const P_MDLinkInner: Parser<[string, string | undefined, string | undefined]> = P.sequence(
 	P_FilePath, // the file path
 	P.string('#').then(P.manyNotOf('[]#|^:')).optional(), // the optional heading
 	P.string('|').then(P.manyNotOf('[]')).optional(), // the optional alias
 );
 
+/**
+ * @internal
+ */
 const P_MDLink: Parser<MarkdownLink> = P.or(
 	// wiki links
 	P.sequenceMap(
@@ -41,6 +50,9 @@ export function isUrl(str: string): boolean {
 	}
 }
 
+/**
+ * Represents a markdown link.
+ */
 export class MarkdownLink {
 	isEmbed: boolean;
 	target: string;
@@ -69,6 +81,21 @@ export class MarkdownLink {
 	}
 
 	toTFile(app: App, sourcePath: string): TFile | undefined {
+		if (!this.internal) {
+			return undefined;
+		}
 		return app.metadataCache.getFirstLinkpathDest(this.target, sourcePath) ?? undefined;
 	}
+
+	toString(): string {
+		const embed = this.isEmbed ? '!' : '';
+
+		if (this.internal) {
+			const alias = this.alias ? `|${this.alias}` : '';
+			return `${embed}[[${this.fullTarget()}${alias}]]`;
+		} else {
+			const alias = this.alias ?? this.fullTarget();
+			return `${embed}[${alias}](${this.fullTarget()})`;
+		}
+	}
 }