@sillsdev/docu-notion 0.11.1

package/dist/NotionImage-CaptionReading.spec.js

@@ -0,0 +1,233 @@
+"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 images_1 = require("./images");
+const kPrimaryImageUrl = "https://s3.us-west-2.amazonaws.com/primaryImage.png?Blah=foo";
+/* didn't work?
+beforeAll(async () => {
+  console.log("before");
+  await initImageHandling("", "", []);
+  console.log("azfter");
+});
+*/
+/* eslint-disable @typescript-eslint/require-await */
+test("finds primary image url", () => __awaiter(void 0, void 0, void 0, function* () {
+    yield (0, images_1.initImageHandling)("", "", []);
+    const img = (0, images_1.parseImageBlock)(kImageBlockWithTwoLocalizedImages.image);
+    expect(img.primaryUrl).toBe(kPrimaryImageUrl);
+}));
+test("primary caption content after image links are removed", () => __awaiter(void 0, void 0, void 0, function* () {
+    yield (0, images_1.initImageHandling)("", "", []);
+    const img = (0, images_1.parseImageBlock)(kImageBlockWithTwoLocalizedImagesWrappedWithActualCaptionText.image);
+    // carriage returns seem to mess up the markdown, so should be removed
+    expect(img.caption).toBe("Caption before images. Caption after images.");
+}));
+test("gets localized image links", () => __awaiter(void 0, void 0, void 0, function* () {
+    yield (0, images_1.initImageHandling)("", "", []);
+    const img = (0, images_1.parseImageBlock)(kImageBlockWithTwoLocalizedImagesWrappedWithActualCaptionText.image);
+    expect(img.localizedUrls.length).toBe(2);
+    expect(img.localizedUrls[0].iso632Code).toBe("fr");
+    expect(img.localizedUrls[1].iso632Code).toBe("es");
+    expect(img.localizedUrls[0].url).toBe("https://i.imgur.com/pYmE7OJ.png");
+    expect(img.localizedUrls[1].url).toBe("https://i.imgur.com/8paSZ0i.png");
+}));
+const kImageBlockWithTwoLocalizedImagesWrappedWithActualCaptionText = {
+    object: "block",
+    id: "20b821b4-7c5b-41dc-8e30-92c23c125580",
+    parent: { type: "page_id", page_id: "9dd05134-0401-47f6-b159-1e6b76b9aad3" },
+    created_time: "2022-07-25T23:05:00.000Z",
+    last_edited_time: "2022-07-26T15:31:00.000Z",
+    created_by: { object: "user", id: "11fb7f16-0560-4aee-ab88-ed75a850cfc4" },
+    last_edited_by: {
+        object: "user",
+        id: "11fb7f16-0560-4aee-ab88-ed75a850cfc4",
+    },
+    has_children: false,
+    archived: false,
+    type: "image",
+    image: {
+        caption: [
+            {
+                type: "text",
+                text: { content: "Caption before images. fr-", link: null },
+                annotations: {
+                    bold: false,
+                    italic: false,
+                    strikethrough: false,
+                    underline: false,
+                    code: false,
+                    color: "default",
+                },
+                plain_text: "Caption before images.\nfr ",
+                href: null,
+            },
+            {
+                type: "text",
+                text: {
+                    content: "https://i.imgur.com/pYmE7OJ.png",
+                    link: { url: "https://i.imgur.com/pYmE7OJ.png" },
+                },
+                annotations: {
+                    bold: false,
+                    italic: false,
+                    strikethrough: false,
+                    underline: false,
+                    code: false,
+                    color: "default",
+                },
+                plain_text: "https://i.imgur.com/pYmE7OJ.png",
+                href: "https://i.imgur.com/pYmE7OJ.png",
+            },
+            {
+                type: "text",
+                text: { content: " es-", link: null },
+                annotations: {
+                    bold: false,
+                    italic: false,
+                    strikethrough: false,
+                    underline: false,
+                    code: false,
+                    color: "default",
+                },
+                plain_text: "\nES  ",
+                href: null,
+            },
+            {
+                type: "text",
+                text: {
+                    content: "https://i.imgur.com/8paSZ0i.png",
+                    link: { url: "https://i.imgur.com/8paSZ0i.png" },
+                },
+                annotations: {
+                    bold: false,
+                    italic: false,
+                    strikethrough: false,
+                    underline: false,
+                    code: false,
+                    color: "default",
+                },
+                plain_text: "https://i.imgur.com/8paSZ0i.png",
+                href: "https://i.imgur.com/8paSZ0i.png",
+            },
+            {
+                type: "text",
+                text: { content: "\nCaption after images", link: null },
+                annotations: {
+                    bold: false,
+                    italic: false,
+                    strikethrough: false,
+                    underline: false,
+                    code: false,
+                    color: "default",
+                },
+                plain_text: "\nCaption after images.",
+                href: null,
+            },
+        ],
+        type: "file",
+        file: {
+            url: kPrimaryImageUrl,
+            expiry_time: "2022-07-26T16:35:44.029Z",
+        },
+    },
+};
+const kImageBlockWithTwoLocalizedImages = {
+    object: "block",
+    id: "20b821b4-7c5b-41dc-8e30-92c23c125580",
+    parent: {
+        type: "page_id",
+        page_id: "9dd05134-0401-47f6-b159-1e6b76b9aad3",
+    },
+    created_time: "2022-07-25T23:05:00.000Z",
+    last_edited_time: "2022-07-25T23:07:00.000Z",
+    created_by: {
+        object: "user",
+        id: "11fb7f16-0560-4aee-ab88-ed75a850cfc4",
+    },
+    last_edited_by: {
+        object: "user",
+        id: "11fb7f16-0560-4aee-ab88-ed75a850cfc4",
+    },
+    has_children: false,
+    archived: false,
+    type: "image",
+    image: {
+        caption: [
+            {
+                type: "text",
+                text: { content: "fr-", link: null },
+                annotations: {
+                    bold: false,
+                    italic: false,
+                    strikethrough: false,
+                    underline: false,
+                    code: false,
+                    color: "default",
+                },
+                plain_text: "fr-",
+                href: null,
+            },
+            {
+                type: "text",
+                text: {
+                    content: "https://i.imgur.com/pYmE7OJ.png",
+                    link: { url: "https://i.imgur.com/pYmE7OJ.png" },
+                },
+                annotations: {
+                    bold: false,
+                    italic: false,
+                    strikethrough: false,
+                    underline: false,
+                    code: false,
+                    color: "default",
+                },
+                plain_text: "https://i.imgur.com/pYmE7OJ.png",
+                href: "https://i.imgur.com/pYmE7OJ.png",
+            },
+            {
+                type: "text",
+                text: { content: " es-", link: null },
+                annotations: {
+                    bold: false,
+                    italic: false,
+                    strikethrough: false,
+                    underline: false,
+                    code: false,
+                    color: "default",
+                },
+                plain_text: " es-",
+                href: null,
+            },
+            {
+                type: "text",
+                text: {
+                    content: "https://i.imgur.com/8paSZ0i.png",
+                    link: { url: "https://i.imgur.com/8paSZ0i.png" },
+                },
+                annotations: {
+                    bold: false,
+                    italic: false,
+                    strikethrough: false,
+                    underline: false,
+                    code: false,
+                    color: "default",
+                },
+                plain_text: "https://i.imgur.com/8paSZ0i.png",
+                href: "https://i.imgur.com/8paSZ0i.png",
+            },
+        ],
+        type: "file",
+        file: {
+            url: kPrimaryImageUrl,
+            expiry_time: "2022-07-26T00:19:09.096Z",
+        },
+    },
+};

package/dist/NotionPage.d.ts

@@ -0,0 +1,45 @@
+import { GetPageResponse } from "@notionhq/client/build/src/api-endpoints";
+import { ListBlockChildrenResponseResults } from "notion-to-md/build/types";
+export declare enum PageType {
+    DatabasePage = 0,
+    Simple = 1
+}
+export declare class NotionPage {
+    metadata: GetPageResponse;
+    pageId: string;
+    order: number;
+    layoutContext: string;
+    foundDirectlyInOutline: boolean;
+    constructor(args: {
+        layoutContext: string;
+        pageId: string;
+        order: number;
+        metadata: GetPageResponse;
+        foundDirectlyInOutline: boolean;
+    });
+    matchesLinkId(id: string): boolean;
+    get type(): PageType;
+    get nameOrTitle(): string;
+    nameForFile(): string;
+    private get title();
+    private get name();
+    private explicitSlug;
+    get slug(): string;
+    get hasExplicitSlug(): boolean;
+    get keywords(): string | undefined;
+    get status(): string | undefined;
+    getPlainTextProperty(property: string, defaultIfEmpty: string): string;
+    getSelectProperty(property: string): string | undefined;
+    getDateProperty(property: string, defaultIfEmpty: string, start?: boolean): string;
+    getContentInfo(children: ListBlockChildrenResponseResults): Promise<{
+        childPageIdsAndOrder: {
+            id: string;
+            order: number;
+        }[];
+        linksPageIdsAndOrder: {
+            id: string;
+            order: number;
+        }[];
+        hasParagraphs: boolean;
+    }>;
+}

package/dist/NotionPage.js

@@ -0,0 +1,229 @@
+"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 });
+exports.NotionPage = exports.PageType = void 0;
+const internalLinks_1 = require("./plugins/internalLinks");
+// Notion has 2 kinds of pages: a normal one which is just content, and what I'm calling a "database page", which has whatever properties you put on it.
+// docu-notion supports the later via links from outline pages. That is, you put the database pages in a database, then separately, in the outline, you
+// create pages for each node of the outline and then add links from those to the database pages. In this way, we get the benefits of database
+// pages (metadata, workflow, etc) and also normal pages (order, position in the outline).
+var PageType;
+(function (PageType) {
+    PageType[PageType["DatabasePage"] = 0] = "DatabasePage";
+    PageType[PageType["Simple"] = 1] = "Simple";
+})(PageType = exports.PageType || (exports.PageType = {}));
+class NotionPage {
+    constructor(args) {
+        this.layoutContext = args.layoutContext;
+        this.pageId = args.pageId;
+        this.order = args.order;
+        this.metadata = args.metadata;
+        this.foundDirectlyInOutline = args.foundDirectlyInOutline;
+        // review: this is expensive to learn as it takes another api call... I
+        // think? We can tell if it's a database because it has a "Name" instead of a
+        // "tile" and "parent": "type": "database_id". But do we need to differentiate
+        //this.type = PageType.Unknown;
+    }
+    matchesLinkId(id) {
+        const { baseLinkId } = (0, internalLinks_1.parseLinkId)(id);
+        const match = baseLinkId === this.pageId || // from a link_to_page.pageId, which still has the dashes
+            baseLinkId === this.pageId.replaceAll("-", ""); // from inline links, which are lacking the dashes
+        // logDebug(
+        //   `matchedLinkId`,
+        //   `comparing pageId:${this.pageId} to id ${id} --> ${match.toString()}`
+        // );
+        return match;
+    }
+    get type() {
+        /*
+        {
+            "object": "page",
+            "parent": {
+                "type": "page_id",
+                or
+                "type": "database_id",
+                ...
+            },
+        */
+        return this.metadata.parent.type === "database_id"
+            ? PageType.DatabasePage
+            : PageType.Simple;
+    }
+    // In Notion, pages from the Database have names and simple pages have titles.
+    get nameOrTitle() {
+        return this.type === PageType.DatabasePage ? this.name : this.title;
+    }
+    nameForFile() {
+        var _a;
+        // In Notion, pages from the Database have names and simple pages have titles.
+        return this.type === PageType.Simple
+            ? this.title
+            : // if it's a Database page, then we'll use the slug unless there is none, then we'd rather have the
+                // page name than an ugly id for the file name
+                ((_a = this.explicitSlug()) === null || _a === void 0 ? void 0 : _a.replace(/^\//, "")) || this.name;
+    }
+    // TODO: let's go farther in hiding this separate title vs name stuff. This seems like an implementation detail on the Notion side.
+    // In Notion, pages from the Outline have "title"'s.
+    get title() {
+        return this.getPlainTextProperty("title", "title missing");
+    }
+    // In Notion, pages from the Database have "Name"s.
+    get name() {
+        return this.getPlainTextProperty("Name", "name missing");
+    }
+    explicitSlug() {
+        const explicitSlug = this.getPlainTextProperty("Slug", "");
+        if (explicitSlug) {
+            if (explicitSlug === "/")
+                return explicitSlug;
+            // the root page
+            else
+                return ("/" +
+                    encodeURIComponent(explicitSlug
+                        .replace(/^\//, "")
+                        // If for some reason someone types in a slug with special characters,
+                        //we really don't want to see ugly entities in the URL, so first
+                        // we replace a bunch of likely suspects with dashes. This will not
+                        // adequately handle the case where there is one pag with slug:"foo-bar"
+                        // and another with "foo?bar". Both will come out "foo-bar"
+                        .replaceAll(" ", "-")
+                        .replaceAll("?", "-")
+                        .replaceAll("/", "-")
+                        .replaceAll("#", "-")
+                        .replaceAll("&", "-")
+                        .replaceAll("%", "-")
+                        // remove consecutive dashes
+                        .replaceAll("--", "-")));
+            return undefined; // this page has no slug property
+        }
+    }
+    get slug() {
+        var _a;
+        return (_a = this.explicitSlug()) !== null && _a !== void 0 ? _a : "/" + this.pageId;
+    }
+    get hasExplicitSlug() {
+        return this.explicitSlug() !== undefined;
+    }
+    get keywords() {
+        return this.getPlainTextProperty("Keywords", "");
+    }
+    get status() {
+        return this.getSelectProperty("Status");
+    }
+    getPlainTextProperty(property, defaultIfEmpty) {
+        /* Notion strings look like this
+       "properties": {
+          "slug": {
+            "type": "rich_text",
+            ...
+            "rich_text": [
+              {
+                ...
+                "plain_text": "/",
+              }
+            ]
+          },
+           "Name": {
+            "type": "title",
+            "title": [
+              {
+                ...
+                "plain_text": "Intro",
+              },
+              {
+                ...
+                "plain_text": " to Notion",
+              }
+            ]
+          */
+        var _a;
+        //console.log("metadata:\n" + JSON.stringify(this.metadata, null, 2));
+        const p = (_a = this.metadata.properties) === null || _a === void 0 ? void 0 : _a[property];
+        //console.log(`prop ${property} = ${JSON.stringify(p)}`);
+        if (!p)
+            return defaultIfEmpty;
+        const textArray = p[p.type];
+        //console.log("textarray:" + JSON.stringify(textArray, null, 2));
+        return textArray && textArray.length
+            ? textArray
+                .map((item) => item.plain_text)
+                .join("")
+            : defaultIfEmpty;
+    }
+    getSelectProperty(property) {
+        /* Notion select values look like this
+         "properties": {
+            "Status": {
+              "id": "oB~%3D",
+              "type": "select",
+              "select": {
+                "id": "1",
+                "name": "Ready For Review",
+                "color": "red"
+              }
+            },
+            */
+        var _a, _b;
+        const p = (_a = this.metadata.properties) === null || _a === void 0 ? void 0 : _a[property];
+        if (!p) {
+            throw new Error(`missing ${property} in ${JSON.stringify(this.metadata, null, 2)}`);
+            return undefined;
+        }
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        return ((_b = p.select) === null || _b === void 0 ? void 0 : _b.name) || undefined;
+    }
+    getDateProperty(property, defaultIfEmpty, start = true) {
+        /* Notion dates look like this
+       "properties": {
+          "published_date":
+          {
+            "id":"a%3Cql",
+            "type":"date",
+            "date":{
+              "start":"2021-10-24",
+              "end":null,
+              "time_zone":null
+            }
+          }
+        }
+        */
+        var _a, _b, _c;
+        // console.log("metadata:\n" + JSON.stringify(this.metadata, null, 2));
+        const p = (_a = this.metadata.properties) === null || _a === void 0 ? void 0 : _a[property];
+        // console.log(`prop ${property} = ${JSON.stringify(p)}`);
+        if (!p)
+            return defaultIfEmpty;
+        if (start) {
+            return ((_b = p === null || p === void 0 ? void 0 : p.date) === null || _b === void 0 ? void 0 : _b.start) ? p.date.start : defaultIfEmpty;
+        }
+        else {
+            return ((_c = p === null || p === void 0 ? void 0 : p.date) === null || _c === void 0 ? void 0 : _c.end) ? p.date.end : defaultIfEmpty;
+        }
+    }
+    getContentInfo(children) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (let i = 0; i < children.length; i++) {
+                children[i].order = i;
+            }
+            return {
+                childPageIdsAndOrder: children
+                    .filter((b) => b.type === "child_page")
+                    .map((b) => ({ id: b.id, order: b.order })),
+                linksPageIdsAndOrder: children
+                    .filter((b) => b.type === "link_to_page")
+                    .map((b) => ({ id: b.link_to_page.page_id, order: b.order })),
+                hasParagraphs: children.some(b => b.type === "paragraph" &&
+                    b.paragraph.rich_text.length > 0),
+            };
+        });
+    }
+}
+exports.NotionPage = NotionPage;

package/dist/NotionPage.spec.d.ts

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

package/dist/NotionPage.spec.js

@@ -0,0 +1,143 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const NotionPage_1 = require("./NotionPage");
+describe("NotionPage", () => {
+    const mockMetadata = {
+        object: "page",
+        id: "6e6921b9-b1f5-4614-ab3c-bf1a73358a1f",
+        created_time: "2023-04-11T10:17:00.000Z",
+        last_edited_time: "2023-04-13T20:24:00.000Z",
+        created_by: {
+            object: "user",
+            id: "USERID",
+        },
+        last_edited_by: {
+            object: "user",
+            id: "USERID",
+        },
+        cover: null,
+        icon: {
+            type: "file",
+            file: {
+                url: "https:/dummy_URL",
+                expiry_time: "2023-04-15T11:50:20.461Z",
+            },
+        },
+        parent: {
+            type: "workspace",
+            workspace: true,
+        },
+        archived: false,
+        properties: {
+            title: {
+                id: "title",
+                type: "title",
+                title: [
+                    {
+                        type: "text",
+                        text: {
+                            content: "Foo",
+                            link: null,
+                        },
+                        annotations: {
+                            bold: false,
+                            italic: false,
+                            strikethrough: false,
+                            underline: false,
+                            code: false,
+                            color: "default",
+                        },
+                        plain_text: "Foo",
+                        href: null,
+                    },
+                    {
+                        type: "text",
+                        text: {
+                            content: "Bar",
+                            link: null,
+                        },
+                        annotations: {
+                            bold: false,
+                            italic: false,
+                            strikethrough: false,
+                            underline: false,
+                            code: false,
+                            color: "default",
+                        },
+                        plain_text: "Bar",
+                        href: null,
+                    },
+                ],
+            },
+            date_property: {
+                id: "a%3Cql",
+                type: "date",
+                date: {
+                    start: "2021-10-24",
+                    end: "2021-10-28",
+                    time_zone: null,
+                },
+            },
+        },
+        url: "https://www.notion.so/Site-docu-notion-PAGEID",
+    };
+    describe("getPlainTextProperty", () => {
+        it("should return the plain text value of a property", () => {
+            const page = new NotionPage_1.NotionPage({
+                layoutContext: "Test Context",
+                pageId: "123",
+                order: 1,
+                metadata: mockMetadata,
+                foundDirectlyInOutline: true,
+            });
+            const result = page.getPlainTextProperty("title", "");
+            expect(result).toBe("FooBar");
+        });
+        it("should return the default value if the property is not found", () => {
+            const page = new NotionPage_1.NotionPage({
+                layoutContext: "Test Context",
+                pageId: "123",
+                order: 1,
+                metadata: mockMetadata,
+                foundDirectlyInOutline: true,
+            });
+            const result = page.getPlainTextProperty("nonexistent", "Default Value");
+            expect(result).toBe("Default Value");
+        });
+    });
+    describe("getDateProperty", () => {
+        it("should return the start date property by default", () => {
+            const page = new NotionPage_1.NotionPage({
+                layoutContext: "Test Context",
+                pageId: "123",
+                order: 1,
+                metadata: mockMetadata,
+                foundDirectlyInOutline: true,
+            });
+            const result = page.getDateProperty("date_property", "");
+            expect(result).toBe("2021-10-24");
+        });
+        it("should return the end date if start is false", () => {
+            const page = new NotionPage_1.NotionPage({
+                layoutContext: "Test Context",
+                pageId: "123",
+                order: 1,
+                metadata: mockMetadata,
+                foundDirectlyInOutline: true,
+            });
+            const result = page.getDateProperty("date_property", "", false);
+            expect(result).toBe("2021-10-28");
+        });
+        it("should return the default value if the property is not found", () => {
+            const page = new NotionPage_1.NotionPage({
+                layoutContext: "Test Context",
+                pageId: "123",
+                order: 1,
+                metadata: mockMetadata,
+                foundDirectlyInOutline: true,
+            });
+            const result = page.getPlainTextProperty("nonexistent", "Default Value");
+            expect(result).toBe("Default Value");
+        });
+    });
+});

package/dist/config/configuration.d.ts

@@ -0,0 +1,5 @@
+import { IPlugin } from "../plugins/pluginTypes";
+export type IDocuNotionConfig = {
+    plugins: IPlugin[];
+};
+export declare function loadConfigAsync(): Promise<IDocuNotionConfig>;