@sillsdev/docu-notion 0.11.1

package/dist/plugins/externalLinks.spec.js

@@ -0,0 +1,132 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const log_1 = require("../log");
+const pluginTestRun_1 = require("./pluginTestRun");
+const externalLinks_1 = require("./externalLinks");
+// If you paste a link in notion and then choose "Create bookmark", the markdown
+// would normally be [bookmark](https://example.com)]. Instead of seeing "bookmark",
+// we change to the url.
+test("links turned into bookmarks", () => __awaiter(void 0, void 0, void 0, function* () {
+    (0, log_1.setLogLevel)("debug");
+    const results = yield getMarkdown({
+        type: "bookmark",
+        bookmark: { caption: [], url: "https://github.com" },
+    });
+    expect(results.trim()).toBe("[https://github.com](https://github.com)");
+}));
+test("external link inside callout", () => __awaiter(void 0, void 0, void 0, function* () {
+    const results = yield getMarkdown({
+        type: "callout",
+        callout: {
+            rich_text: [
+                {
+                    type: "text",
+                    text: { content: "Callouts inline ", link: null },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: "Callouts inline ",
+                    href: null,
+                },
+                {
+                    type: "text",
+                    text: {
+                        content: "great page",
+                        link: { url: `https://github.com` },
+                    },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: "great page",
+                    href: `https://github.com`,
+                },
+                {
+                    type: "text",
+                    text: { content: ".", link: null },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: ".",
+                    href: null,
+                },
+            ],
+            icon: { type: "emoji", emoji: "⚠️" },
+            color: "gray_background",
+        },
+    });
+    expect(results.trim()).toBe("> ⚠️ Callouts inline [great page](https://github.com).");
+}));
+test("inline links to external site", () => __awaiter(void 0, void 0, void 0, function* () {
+    const results = yield getMarkdown({
+        type: "paragraph",
+        paragraph: {
+            rich_text: [
+                {
+                    type: "text",
+                    text: { content: "Inline ", link: null },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: "Inline ",
+                    href: null,
+                },
+                {
+                    type: "text",
+                    text: {
+                        content: "github",
+                        link: { url: "https://github.com" },
+                    },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: "github",
+                    href: "https://github.com",
+                },
+            ],
+            color: "default",
+        },
+    });
+    expect(results.trim()).toBe("Inline [github](https://github.com)");
+}));
+function getMarkdown(block) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const config = {
+            plugins: [externalLinks_1.standardExternalLinkConversion],
+        };
+        return yield (0, pluginTestRun_1.oneBlockToMarkdown)(config, block);
+    });
+}

package/dist/plugins/internalLinks.d.ts

@@ -0,0 +1,7 @@
+import { IDocuNotionContext, IPlugin } from "./pluginTypes";
+export declare function convertInternalUrl(context: IDocuNotionContext, url: string): string | undefined;
+export declare function parseLinkId(fullLinkId: string): {
+    baseLinkId: string;
+    fragmentId: string;
+};
+export declare const standardInternalLinkConversion: IPlugin;

package/dist/plugins/internalLinks.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.standardInternalLinkConversion = exports.parseLinkId = exports.convertInternalUrl = void 0;
+const log_1 = require("../log");
+// converts a url to a local link, if it is a link to a page in the Notion site
+// only here for plugins, notion won't normally be giving us raw urls (at least not that I've noticed)
+// If it finds a URL but can't find the page it points to, it will return undefined.
+// If it doesn't find a match at all, it returns undefined.
+function convertInternalUrl(context, url) {
+    const kGetIDFromNotionURL = /https:\/\/www\.notion\.so\S+-([a-z,0-9]+)+.*/;
+    const match = kGetIDFromNotionURL.exec(url);
+    if (match === null) {
+        (0, log_1.warning)(`[standardInternalLinkConversion] Could not parse link ${url} as a Notion URL`);
+        return undefined;
+    }
+    const id = match[1];
+    const pages = context.pages;
+    // find the page where pageId matches hrefFromNotion
+    const targetPage = pages.find(p => {
+        return p.matchesLinkId(id);
+    });
+    if (!targetPage) {
+        // About this situation. See https://github.com/sillsdev/docu-notion/issues/9
+        (0, log_1.warning)(`[standardInternalLinkConversion] Could not find the target of this link. Note that links to outline sections are not supported. ${url}. https://github.com/sillsdev/docu-notion/issues/9`);
+        return undefined;
+    }
+    return convertLinkHref(context, targetPage, url);
+}
+exports.convertInternalUrl = convertInternalUrl;
+// handles the whole markdown link, including the label
+function convertInternalLink(context, markdownLink) {
+    const linkRegExp = /\[([^\]]+)?\]\(\/?([^),^/]+)\)/g;
+    const match = linkRegExp.exec(markdownLink);
+    if (match === null) {
+        (0, log_1.warning)(`[standardInternalLinkConversion] Could not parse link ${markdownLink}`);
+        return markdownLink;
+    }
+    const labelFromNotion = match[1] || "";
+    const hrefFromNotion = match[2];
+    // verbose(
+    //   `[standardInternalLinkConversion] Converting ${markdownLink} with has url ${hrefFromNotion}`
+    // );
+    const pages = context.pages;
+    // find the page where pageId matches hrefFromNotion
+    const targetPage = pages.find(p => {
+        return p.matchesLinkId(hrefFromNotion);
+    });
+    if (!targetPage) {
+        // About this situation. See https://github.com/sillsdev/docu-notion/issues/9
+        (0, log_1.warning)(`[standardInternalLinkConversion] Could not find the target of this link. Note that links to outline sections are not supported. ${markdownLink}. https://github.com/sillsdev/docu-notion/issues/9`);
+        return "**[Problem Internal Link]**";
+    }
+    const label = convertLinkLabel(targetPage, labelFromNotion);
+    const url = convertLinkHref(context, targetPage, hrefFromNotion);
+    return `[${label}](${url})`;
+}
+function convertLinkLabel(targetPage, text) {
+    // In Notion, if you just add a link to a page without linking it to any text, then in Notion
+    // you see the name of the page as the text of the link. But when Notion gives us that same
+    // link, it uses "link_to_page" as the text. So we have to look up the name of the page in
+    // order to fix that.;
+    if (text !== "link_to_page")
+        return text;
+    else
+        return targetPage.nameOrTitle;
+}
+function convertLinkHref(context, targetPage, url) {
+    let convertedLink = context.layoutStrategy.getLinkPathForPage(targetPage);
+    /*****************************
+    NOTE: as of this writing, the official Notion API completely drops links
+    to headings, unless they are part of a inline link.
+    *******************************/
+    // Include the fragment (# and after) if it exists
+    const { fragmentId } = parseLinkId(url);
+    //verbose(`Parsed ${url} and got Fragment ID: ${fragmentId}`);
+    convertedLink += fragmentId;
+    //verbose(`Converting Link ${url} --> ${convertedLink}`);
+    return convertedLink;
+}
+// Parse the link ID to get the base (before the #) and the fragment (# and after).
+function parseLinkId(fullLinkId) {
+    const iHash = fullLinkId.indexOf("#");
+    if (iHash >= 0) {
+        return {
+            baseLinkId: fullLinkId.substring(0, iHash),
+            fragmentId: fullLinkId.substring(iHash),
+        };
+    }
+    return { baseLinkId: fullLinkId, fragmentId: "" };
+}
+exports.parseLinkId = parseLinkId;
+exports.standardInternalLinkConversion = {
+    name: "standard internal link conversion",
+    linkModifier: {
+        // from notion (or notion-md?) we get slightly different hrefs depending on whether the links is "inline"
+        // (has some other text that's been turned into a link) or "raw".
+        // Raw links come in without a leading slash, e.g. [link_to_page](4a6de8c0-b90b-444b-8a7b-d534d6ec71a4)
+        // Inline links come in with a leading slash, e.g. [pointer to the introduction](/4a6de8c0b90b444b8a7bd534d6ec71a4)
+        match: /\[([^\]]+)?\]\((?!mailto:)(\/?[^),^/]+)\)/,
+        convert: convertInternalLink,
+    },
+};

package/dist/plugins/internalLinks.spec.d.ts

@@ -0,0 +1 @@
+export {};