@sillsdev/docu-notion 0.12.0

package/dist/plugins/internalLinks.d.ts

@@ -0,0 +1,6 @@
+import { IPlugin } from "./pluginTypes";
+export declare function parseLinkId(fullLinkId: string): {
+    baseLinkId: string;
+    fragmentId: string;
+};
+export declare const standardInternalLinkConversion: IPlugin;

package/dist/plugins/internalLinks.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.standardInternalLinkConversion = exports.parseLinkId = void 0;
+const log_1 = require("../log");
+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)
+        // we only want the inline ones for this plugin
+        // review: currently we expect that internal links have an opening slash, but at one point it was optional.
+        match: /\[([^\]]+)?\]\(\/([^),^/]+)\)/,
+        convert: convertInternalLink,
+    },
+};

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

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

package/dist/plugins/internalLinks.spec.js

@@ -0,0 +1,442 @@
+"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 CalloutTransformer_1 = require("./CalloutTransformer");
+const externalLinks_1 = require("./externalLinks");
+const internalLinks_1 = require("./internalLinks");
+const NumberedListTransformer_1 = require("./NumberedListTransformer");
+test("urls that show up as raw text get left that way", () => __awaiter(void 0, void 0, void 0, function* () {
+    const results = yield getMarkdown({
+        type: "paragraph",
+        paragraph: {
+            rich_text: [
+                {
+                    type: "text",
+                    text: { content: "https://github.com", link: null },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: "https://github.com",
+                    href: null,
+                },
+            ],
+        },
+    });
+    expect(results.trim()).toBe("https://github.com");
+}));
+test("link to an existing page on this site that has no slug", () => __awaiter(void 0, void 0, void 0, function* () {
+    const targetPageId = "123";
+    const targetPage = (0, pluginTestRun_1.makeSamplePageObject)({
+        slug: undefined,
+        name: "Hello World",
+        id: targetPageId,
+    });
+    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: "great page",
+                        link: { url: `/${targetPageId}` },
+                    },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: "great page",
+                    href: `/${targetPageId}`,
+                },
+                {
+                    type: "text",
+                    text: { content: " the end.", link: null },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: " the end.",
+                    href: null,
+                },
+            ],
+            color: "default",
+        },
+    }, targetPage);
+    expect(results.trim()).toBe(`Inline [great page](/${targetPageId}) the end.`);
+}));
+test("link to a heading block on a page", () => __awaiter(void 0, void 0, void 0, function* () {
+    const targetPageId = "123";
+    const blocks = {
+        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: "heading on some page",
+                        link: { url: `/${targetPageId}#456` },
+                    },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: "heading on some page",
+                    href: `/${targetPageId}#456`,
+                },
+                {
+                    type: "text",
+                    text: { content: " the end.)", link: null },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: " the end.)",
+                    href: null,
+                },
+            ],
+            color: "default",
+        },
+    };
+    (0, log_1.setLogLevel)("verbose");
+    const noSlugTargetPage = (0, pluginTestRun_1.makeSamplePageObject)({
+        slug: undefined,
+        name: "Hello World",
+        id: targetPageId,
+    });
+    const noSlugResults = yield getMarkdown(blocks, noSlugTargetPage);
+    // the ending parentheses messed up a regex at one point.
+    expect(noSlugResults.trim()).toBe(`(Inline [heading on some page](/${targetPageId}#456) the end.)`);
+    const slugTargetPage = (0, pluginTestRun_1.makeSamplePageObject)({
+        slug: "hello-world",
+        name: "Hello World",
+        id: targetPageId,
+    });
+    const slugResults = yield getMarkdown(blocks, slugTargetPage);
+    expect(slugResults.trim()).toBe(`(Inline [heading on some page](/hello-world#456) the end.)`);
+}));
+test("link to an existing page on this site uses slug", () => __awaiter(void 0, void 0, void 0, function* () {
+    const targetPageId = "123";
+    const targetPage = (0, pluginTestRun_1.makeSamplePageObject)({
+        slug: "hello-world",
+        name: "Hello World",
+        id: targetPageId,
+    });
+    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: "It’s good",
+                        link: { url: `/${targetPageId}` },
+                    },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: "It’s good",
+                    href: `/${targetPageId}`,
+                },
+            ],
+            color: "default",
+        },
+    }, targetPage);
+    expect(results.trim()).toBe("Inline [It’s good](/hello-world)");
+}));
+test("link in a bulleted list", () => __awaiter(void 0, void 0, void 0, function* () {
+    const targetPageId = "123";
+    const targetPage = (0, pluginTestRun_1.makeSamplePageObject)({
+        slug: "the-page",
+        name: "Something",
+        id: targetPageId,
+    });
+    const results = yield getMarkdown({
+        type: "bulleted_list_item",
+        bulleted_list_item: {
+            rich_text: [
+                {
+                    type: "text",
+                    text: {
+                        content: "item",
+                        link: { url: "/123" },
+                    },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: "item",
+                    href: "/123",
+                },
+            ],
+            color: "default",
+        },
+    }, targetPage);
+    expect(results.trim()).toBe("- [item](/the-page)");
+}));
+test("link to an a heading on a page on this site uses slug", () => __awaiter(void 0, void 0, void 0, function* () {
+    const targetPageId = "123";
+    const headingBlockId = "456";
+    const targetPage = (0, pluginTestRun_1.makeSamplePageObject)({
+        slug: "hello-world",
+        name: "Hello World",
+        id: targetPageId,
+    });
+    const results = yield getMarkdown({
+        type: "paragraph",
+        paragraph: {
+            rich_text: [
+                {
+                    type: "text",
+                    text: {
+                        content: "see this heading",
+                        link: { url: `/${targetPageId}#${headingBlockId}` },
+                    },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: "see this heading",
+                    href: `/${targetPageId}#${headingBlockId}`,
+                },
+            ],
+            color: "default",
+        },
+    }, targetPage);
+    expect(results.trim()).toBe(`[see this heading](/hello-world#${headingBlockId})`);
+}));
+test("does not interfere with mailto links", () => __awaiter(void 0, void 0, void 0, function* () {
+    const results = yield getMarkdown({
+        type: "paragraph",
+        paragraph: {
+            rich_text: [
+                {
+                    type: "text",
+                    text: {
+                        content: "mailme",
+                        link: { url: `mailto:foo@example.com` },
+                    },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: "mailme",
+                    href: `mailto:foo@example.com`,
+                },
+            ],
+            color: "default",
+        },
+    });
+    expect(results.trim()).toBe(`[mailme](mailto:foo@example.com)`);
+}));
+test("links to other notion pages that are not in this site give PROBLEM LINK", () => __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: "links page",
+                        link: { url: "/pretendidofpagewedonothaveinthissite" },
+                    },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: "links page",
+                    href: "/pretendidofpagewedonothaveinthissite",
+                },
+            ],
+            color: "default",
+        },
+    });
+    expect(results.trim()).toBe("Inline **[Problem Internal Link]**");
+}));
+test("internal link inside callout", () => __awaiter(void 0, void 0, void 0, function* () {
+    const targetPageId = "123";
+    const targetPage = (0, pluginTestRun_1.makeSamplePageObject)({
+        slug: "hello-world",
+        name: "Hello World",
+        id: targetPageId,
+    });
+    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: `/${targetPageId}` },
+                    },
+                    annotations: {
+                        bold: false,
+                        italic: false,
+                        strikethrough: false,
+                        underline: false,
+                        code: false,
+                        color: "default",
+                    },
+                    plain_text: "great page",
+                    href: `/${targetPageId}`,
+                },
+                {
+                    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",
+        },
+    }, targetPage);
+    expect(results.trim()).toBe(`:::caution
+
+Callouts inline [great page](/hello-world).
+
+:::`);
+}));
+function getMarkdown(block, targetPage) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const config = {
+            plugins: [
+                CalloutTransformer_1.standardCalloutTransformer,
+                NumberedListTransformer_1.standardNumberedListTransformer,
+                internalLinks_1.standardInternalLinkConversion,
+                externalLinks_1.standardExternalLinkConversion,
+            ],
+        };
+        return yield (0, pluginTestRun_1.oneBlockToMarkdown)(config, block, targetPage);
+    });
+}

package/dist/plugins/pluginTestRun.d.ts

@@ -0,0 +1,10 @@
+import { NotionPage } from "../NotionPage";
+import { IDocuNotionConfig } from "../config/configuration";
+import { NotionBlock } from "../types";
+export declare function blocksToMarkdown(config: IDocuNotionConfig, blocks: NotionBlock[], pages?: NotionPage[]): Promise<string>;
+export declare function makeSamplePageObject(options: {
+    slug?: string;
+    name?: string;
+    id?: string;
+}): NotionPage;
+export declare function oneBlockToMarkdown(config: IDocuNotionConfig, block: object, targetPage?: NotionPage): Promise<string>;