Enhance link indexing to support additional link types

* New "type" attribute for links (page, file, url)
* Now indexes external links as well

Author: zefhemel

plugs/index/link.test.ts

@@ -9,7 +9,7 @@ const testPage = `
 ---
 attribute: "[[fm-link]]"
 ---
-This is a [[page-link]] to [[aliased-link|aliased]], or [this](md-link), and [[broken]]
+This is a [[page-link]] to [[aliased-link|aliased]], or [this](md-link), and [[broken]], or [external](https://example.com), or [document](test.jpg), or [[test2.jpg]]
 `.trim();
 
 Deno.test("Test page link indexing", async () => {
@@ -34,11 +34,22 @@ Deno.test("Test page link indexing", async () => {
   };
 
   const objects = await indexLinks(pageMeta, frontmatter, tree, testPage);
-  // console.log(objects);
-  assertEquals(objects.length, 6); // 5 links + 1 aspiring page
+  assertEquals(objects.length, 9); // 7 links + 1 aspiring page
   assertEquals(objects[0].toPage, "fm-link");
+  assertEquals(objects[0].type, "page");
   assertEquals(objects[1].toPage, "page-link");
+  assertEquals(objects[1].type, "page");
   assertEquals(objects[2].toPage, "aliased-link");
+  assertEquals(objects[2].type, "page");
   assertEquals(objects[2].alias, "aliased");
   assertEquals(objects[3].toPage, "folder/md-link"); // relative
+  assertEquals(objects[3].type, "page");
+  assertEquals(objects[4].toPage, "broken");
+  assertEquals(objects[4].type, "page");
+  assertEquals(objects[5].toURL, "https://example.com");
+  assertEquals(objects[5].type, "url");
+  assertEquals(objects[6].toFile, "folder/test.jpg");
+  assertEquals(objects[6].type, "file");
+  assertEquals(objects[7].toFile, "test2.jpg");
+  assertEquals(objects[7].type, "file");
 });

plugs/index/link.ts

@@ -27,26 +27,21 @@ import type {
 } from "@silverbulletmd/silverbullet/type/index";
 import { extractSnippet } from "./snippet.ts";
 
-export type LinkObject = ObjectValue<
-  & {
-    // Common to all links
-    page: string;
-    pos: number;
-    snippet: string;
-    alias?: string;
-    pageLastModified: string;
-  }
-  & ({
-    // Page Link
-    toPage: string;
-    toFile?: never;
-  } | {
-    // Document Link
-    toFile: string;
-    // The page the link occurs in
-    toPage?: never;
-  })
->;
+export type LinkObject = ObjectValue<{
+  // Common to all links
+  page: string;
+  pos: number;
+  type: "page" | "file" | "url";
+  snippet: string;
+  alias?: string;
+  pageLastModified: string;
+  // Page Link
+  toPage?: string;
+  // File Link
+  toFile?: string;
+  // External URL
+  toURL?: string;
+}>;
 
 /**
  * Represents a page that does not yet exist, but is being linked to. A page "aspiring" to be created.
@@ -84,8 +79,9 @@ export async function indexLinks(
       const url = wikiLinkPage.children![0].text!;
       const pos = wikiLinkPage.from!;
 
-      const link: Partial<LinkObject> = {
+      const link: LinkObject = {
         ref: `${name}@${pos}`,
+        type: "page", // can be swapped later
         tag: "link",
         snippet: extractSnippet(name, pageText, pos),
         pos,
@@ -100,8 +96,10 @@ export async function indexLinks(
         return true;
       } else if (isMarkdownPath(ref.path)) {
         link.toPage = getNameFromPath(ref.path);
+        link.type = "page";
       } else {
         link.toFile = ref.path;
+        link.type = "file";
       }
 
       if (wikiLinkAlias) {
@@ -112,44 +110,48 @@ export async function indexLinks(
       return true;
     }
 
-    // Also index [Markdown style]() links
+    // Index [markdown style]() links
     if (n.type === "Link" || n.type === "Image") {
       // The [[Wiki links]] also have a wrapping Image node, but this just fails at the regex
       mdLinkRegex.lastIndex = 0;
       const match = mdLinkRegex.exec(renderToText(n));
       if (!match) {
         return false;
       }
-      let { title: alias, url } = match.groups as {
+      const { title: alias, url } = match.groups as {
         url: string;
         title: string;
       };
 
       // Check if local link
-      if (!isLocalURL(url)) {
-        return false;
-      }
       const pos = n.from!;
-      url = resolveMarkdownLink(name, decodeURI(url));
-
-      const link: Partial<LinkObject> = {
+      const link: LinkObject = {
         ref: `${name}@${pos}`,
         tag: "link",
+        type: "page", // swapped out later if needed
         snippet: extractSnippet(name, pageText, pos),
         pos,
         range: [n.from!, n.to!],
         page: name,
         pageLastModified: pageMeta.lastModified,
       };
 
-      const ref = parseToRef(url);
-      if (!ref) {
-        // Invalid links aren't indexed
-        return true;
-      } else if (isMarkdownPath(ref.path)) {
-        link.toPage = getNameFromPath(ref.path);
+      if (isLocalURL(url)) {
+        const ref = parseToRef(resolveMarkdownLink(name, decodeURI(url)));
+        if (!ref) {
+          // Invalid links aren't indexed
+          return true;
+        } else if (isMarkdownPath(ref.path)) {
+          link.toPage = getNameFromPath(ref.path);
+          link.type = "page";
+        } else {
+          link.toFile = ref.path;
+          link.type = "file";
+        }
       } else {
-        link.toFile = ref.path;
+        // External URL
+        link.type = "url";
+        link.toURL = url;
       }
 
       if (alias) {
@@ -174,9 +176,10 @@ export async function indexLinks(
         if (match && match.groups && match[0] === trimmed) {
           const { leadingTrivia, stringRef, alias } = match.groups;
           const pos = textNode.from! + match.index! + leadingTrivia.length;
-          const link: Partial<LinkObject> = {
+          const link: LinkObject = {
             ref: `${name}@${pos}`,
             tag: "link",
+            type: "page", // final value set later
             page: name,
             snippet: extractSnippet(name, pageText, pos),
             pos: pos,
@@ -193,8 +196,10 @@ export async function indexLinks(
             return true;
           } else if (isMarkdownPath(ref.path)) {
             link.toPage = getNameFromPath(ref.path);
+            link.type = "page";
           } else {
             link.toFile = ref.path;
+            link.type = "file";
           }
 
           if (alias) {