notion-to-md 1.0.7 → 2.1.0

package/README.md

@@ -24,6 +24,7 @@ Convert notion pages, block and list of blocks to markdown (supports nesting) us
 - [x] divider
 - [x] equation block (converted to code blocks)
 - [x] convert returned markdown object to string (`toMarkdownString()`)
+- [x] typescript support
 - [ ] add tests
 
 ## Install
@@ -34,6 +35,8 @@ $ npm install notion-to-md
 
 ## Usage
 
+> **Note:** Details on methods can be found in [API section](https://github.com/souvikinator/notion-to-md#api)
+
 ### converting markdown objects to markdown string
 
 This is how the notion page looks for this example:
@@ -42,14 +45,14 @@ This is how the notion page looks for this example:
 
 ```js
 const { Client } = require("@notionhq/client");
-const notion2md = require("notion-to-md");
+const { NotionToMarkdown } = require("notion-to-md");
 
 const notion = new Client({
   auth: "your integration token",
 });
 
 // passing notion client to the option
-const n2m = new notion2md({ notionClient: notion });
+const n2m = new NotionToMarkdown({ notionClient: notion });
 
 (async () => {
   const mdblocks = await n2m.pageToMarkdown("target_page_id");
@@ -68,23 +71,24 @@ const n2m = new notion2md({ notionClient: notion });
 
 ### converting page to markdown object
 
-This is how the notion page looks for this example:
+Example notion page:
 
 ![Imgur](https://imgur.com/9iqRpBl.png)
 
 ```js
 const { Client } = require("@notionhq/client");
-const notion2md = require("notion-to-md");
+const { NotionToMarkdown } = require("notion-to-md");
 
 const notion = new Client({
   auth: "your integration token",
 });
 
 // passing notion client to the option
-const n2m = new notion2md({ notionClient: notion });
+const n2m = new NotionToMarkdown({ notionClient: notion });
 
 (async () => {
-  const x = await n2m.pageToMarkdown("target_page_id");
+  // notice second argument, totalPage.
+  const x = await n2m.pageToMarkdown("target_page_id", 2);
   console.log(x);
 })();
 ```
@@ -136,8 +140,6 @@ const n2m = new notion2md({ notionClient: notion });
 
 ### converting list of blocks to markdown object
 
-> This example blocks from a single page is used. One construct array of blocks from different notion pages and pass in to the `blocksToMarkdown()`
-
 same notion page as before
 
 ```js
@@ -169,7 +171,7 @@ const n2m = new notion2md({ notionClient: notion });
 
 - only takes a single notion block and returns corresponding markdown string
 - nesting is ignored
-- not dependent on @notionhq/client
+- independent of @notionhq/client
 
 ```js
 const notion2md = require("notion-to-md");
@@ -189,30 +191,41 @@ console.log(result);
 
 ## API
 
-### `toMarkdownString(markdownObjects)`
-
-- takes output of `pageToMarkdown` or `blocksToMarkdown` as argument
-- convert to markdown string.
-
-### `pageToMarkdown(page_id)`
-
-- Takes page_id as input and converts all the blocks in the page to corresponding markdown
-- Uses `blocksToMarkdown` internally.
-
-### `blockToMarkdown(block)`
-
-- Takes one notion block and converts to markdown
-- does not deal with nested notion blocks
-- This method doesn't require the `notion-sdk-js`.
-- Refer docs to know more about [notion blocks](https://developers.notion.com/reference/block)
-
-### `blocksToMarkdown(blocks)`
-
+> ### `toMarkdownString(mdBlock[])`
+>
+> - takes output of `pageToMarkdown` or `blocksToMarkdown` as argument
+> - converts to markdown string.
+
+> ### `pageToMarkdown(id,totalPage)`
+>
+> - Uses `blocksToMarkdown` internally.
+> - `id`(pageid) as input and converts all the blocks in the page to corresponding markdown object
+> - `totalPage` is the retrieve block children request number i.e `page_size Maximum = totalPage * 100`.
+
+> ### totalPage
+>
+> Default value is `1` which means only `100` blocks will be converted to markdown and rest will be ignored (due to notion api limitations, ref: [#9](https://github.com/souvikinator/notion-to-md/pull/9)).
+>
+> ### How to use `totalPage` arg ?
+>
+> - if the notion page contains less than or equal `100` blocks then `totalPage` arg is not required.
+> - if the notion page contains `150` blocks then `totalPage` argument should be greater than or equal to `2` leading to `pageSize = 2 * 100` and rendering all `150` blocks.
+
+> ### `blocksToMarkdown(blocks,totalPage)`
+>
 > **Note**: requires <u>**notion-sdk-js**</u> unlike `blockToMarkdown`
-
-- `blocks`: array of notion blocks
-- deals with <u>**nested blocks**</u>
-- uses `blockToMarkdown` internally.
+>
+> - `blocks`: array of notion blocks
+> - `totalPage`: the retrieve block children request number i.e `page_size Maximum = totalPage * 100`.
+> - deals with <u>**nested blocks**</u>
+> - uses `blockToMarkdown` internally.
+
+> ### `blockToMarkdown(block)`
+>
+> - Takes single notion block and converts to markdown string
+> - does not deal with nested notion blocks
+> - This method doesn't require the `notion-sdk-js`.
+> - Refer docs to know more about [notion blocks](https://developers.notion.com/reference/block)
 
 ## Contribution
 

package/build/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./notion-to-md";
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC"}

package/build/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./notion-to-md"), exports);
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iDAA+B","sourcesContent":["export * from \"./notion-to-md\";\n"]}

package/build/notion-to-md.d.ts

@@ -0,0 +1,44 @@
+import { Annotations, ListBlockChildrenResponseResult, ListBlockChildrenResponseResults, MdBlock, NotionToMarkdownOptions } from "./types";
+/**
+ * Converts a Notion page to Markdown.
+ */
+export declare class NotionToMarkdown {
+    private notionClient?;
+    constructor(options?: NotionToMarkdownOptions);
+    /**
+     * Converts Markdown Blocks to string
+     * @param {MdBlock[]} mdBlocks - Array of markdown blocks
+     * @param {number} nestingLevel - Defines max depth of nesting
+     * @returns {string} - Returns markdown string
+     */
+    toMarkdownString(mdBlocks?: MdBlock[], nestingLevel?: number): string;
+    /**
+     * Retrieves Notion Blocks based on ID and converts them to Markdown Blocks
+     * @param {string} id - notion page id (not database id)
+     * @param {number} totalPage - Retrieve block children request number, page_size Maximum = totalPage * 100 (Default=1)
+     * @returns {Promise<MdBlock[]>} - List of markdown blocks
+     */
+    pageToMarkdown(id: string, totalPage?: number): Promise<MdBlock[]>;
+    /**
+     * Converts list of Notion Blocks to Markdown Blocks
+     * @param {ListBlockChildrenResponseResults | undefined} blocks - List of notion blocks
+     * @param {number} totalPage - Retrieve block children request number, page_size Maximum = totalPage * 100
+     * @param {MdBlock[]} mdBlocks - Defines max depth of nesting
+     * @returns {Promise<MdBlock[]>} - Array of markdown blocks with their children
+     */
+    blocksToMarkdown(blocks?: ListBlockChildrenResponseResults, totalPage?: number, mdBlocks?: MdBlock[]): Promise<MdBlock[]>;
+    /**
+     * Converts a Notion Block to a Markdown Block
+     * @param {ListBlockChildrenResponseResult} block - single notion block
+     * @returns {string} corresponding markdown string of the passed block
+     */
+    blockToMarkdown(block: ListBlockChildrenResponseResult): string;
+    /**
+     * Annoate text using provided annotations
+     * @param {string} text - String to be annotated
+     * @param {Annotations} annotations - Annotation object of a notion block
+     * @returns {string} - Annotated text
+     */
+    annotatePlainText(text: string, annotations: Annotations): string;
+}
+//# sourceMappingURL=notion-to-md.d.ts.map

package/build/notion-to-md.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notion-to-md.d.ts","sourceRoot":"","sources":["../src/notion-to-md.ts"],"names":[],"mappings":"AACA,OAAO,EACL,WAAW,EACX,+BAA+B,EAC/B,gCAAgC,EAChC,OAAO,EAEP,uBAAuB,EACxB,MAAM,SAAS,CAAC;AAIjB;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,YAAY,CAAC,CAAS;gBAElB,OAAO,CAAC,EAAE,uBAAuB;IAI7C;;;;;OAKG;IACH,gBAAgB,CAAC,QAAQ,GAAE,OAAO,EAAO,EAAE,YAAY,GAAE,MAAU,GAAG,MAAM;IAe5E;;;;;OAKG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,GAAE,MAAU,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAY3E;;;;;;OAMG;IACG,gBAAgB,CACpB,MAAM,CAAC,EAAE,gCAAgC,EACzC,SAAS,GAAE,MAAU,EACrB,QAAQ,GAAE,OAAO,EAAO,GACvB,OAAO,CAAC,OAAO,EAAE,CAAC;IAkCrB;;;;OAIG;IACH,eAAe,CAAC,KAAK,EAAE,+BAA+B,GAAG,MAAM;IA8H/D;;;;;OAKG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,GAAG,MAAM;CAsBlE"}

package/build/notion-to-md.js

@@ -0,0 +1,255 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotionToMarkdown = void 0;
+const md = __importStar(require("./utils/md"));
+const notion_1 = require("./utils/notion");
+/**
+ * Converts a Notion page to Markdown.
+ */
+class NotionToMarkdown {
+    constructor(options) {
+        this.notionClient = options ? options.notionClient : undefined;
+    }
+    /**
+     * Converts Markdown Blocks to string
+     * @param {MdBlock[]} mdBlocks - Array of markdown blocks
+     * @param {number} nestingLevel - Defines max depth of nesting
+     * @returns {string} - Returns markdown string
+     */
+    toMarkdownString(mdBlocks = [], nestingLevel = 0) {
+        let mdString = "";
+        mdBlocks.forEach((mdBlocks) => {
+            if (mdBlocks.parent) {
+                mdString += `
+${md.addTabSpace(mdBlocks.parent, nestingLevel)}
+`;
+            }
+            if (mdBlocks.children && mdBlocks.children.length > 0) {
+                mdString += this.toMarkdownString(mdBlocks.children, nestingLevel + 1);
+            }
+        });
+        return mdString;
+    }
+    /**
+     * Retrieves Notion Blocks based on ID and converts them to Markdown Blocks
+     * @param {string} id - notion page id (not database id)
+     * @param {number} totalPage - Retrieve block children request number, page_size Maximum = totalPage * 100 (Default=1)
+     * @returns {Promise<MdBlock[]>} - List of markdown blocks
+     */
+    async pageToMarkdown(id, totalPage = 1) {
+        if (!this.notionClient) {
+            throw new Error("notion client is not provided, for more details check out https://github.com/souvikinator/notion-to-md");
+        }
+        if (!id)
+            throw new Error("pageToMarkdown takes page_id as argument");
+        const blocks = await (0, notion_1.getBlockChildren)(this.notionClient, id, totalPage);
+        const parsedData = await this.blocksToMarkdown(blocks);
+        return parsedData;
+    }
+    /**
+     * Converts list of Notion Blocks to Markdown Blocks
+     * @param {ListBlockChildrenResponseResults | undefined} blocks - List of notion blocks
+     * @param {number} totalPage - Retrieve block children request number, page_size Maximum = totalPage * 100
+     * @param {MdBlock[]} mdBlocks - Defines max depth of nesting
+     * @returns {Promise<MdBlock[]>} - Array of markdown blocks with their children
+     */
+    async blocksToMarkdown(blocks, totalPage = 1, mdBlocks = []) {
+        if (!this.notionClient) {
+            throw new Error("notion client is not provided, for more details check out https://github.com/souvikinator/notion-to-md");
+        }
+        if (!blocks)
+            return mdBlocks;
+        for (let i = 0; i < blocks.length; i++) {
+            let block = blocks[i];
+            if ("has_children" in block && block.has_children) {
+                let child_blocks = await (0, notion_1.getBlockChildren)(this.notionClient, block.id, totalPage);
+                mdBlocks.push({ parent: this.blockToMarkdown(block), children: [] });
+                let l = mdBlocks.length;
+                await this.blocksToMarkdown(child_blocks, totalPage, mdBlocks[l - 1].children);
+                continue;
+            }
+            let tmp = this.blockToMarkdown(block);
+            mdBlocks.push({ parent: tmp, children: [] });
+        }
+        return mdBlocks;
+    }
+    /**
+     * Converts a Notion Block to a Markdown Block
+     * @param {ListBlockChildrenResponseResult} block - single notion block
+     * @returns {string} corresponding markdown string of the passed block
+     */
+    blockToMarkdown(block) {
+        if (!("type" in block))
+            return "";
+        let parsedData = "";
+        const { type } = block;
+        switch (type) {
+            case "image": {
+                let blockContent = block.image;
+                const image_type = blockContent.type;
+                if (image_type === "external")
+                    return md.image("image", blockContent.external.url);
+                if (image_type === "file")
+                    return md.image("image", blockContent.file.url);
+                break;
+            }
+            case "divider": {
+                return md.divider();
+            }
+            case "equation": {
+                return md.codeBlock(block.equation.expression);
+            }
+            case "video":
+            case "file":
+            case "pdf": {
+                let blockContent;
+                if (type === "video")
+                    blockContent = block.video;
+                if (type === "file")
+                    blockContent = block.file;
+                if (type === "pdf")
+                    blockContent = block.pdf;
+                if (blockContent) {
+                    const file_type = blockContent.type;
+                    if (file_type === "external")
+                        return md.link("image", blockContent.external.url);
+                    if (file_type === "file")
+                        return md.link("image", blockContent.file.url);
+                }
+                break;
+            }
+            case "bookmark":
+            case "embed":
+            case "link_preview": {
+                let blockContent;
+                if (type === "bookmark")
+                    blockContent = block.bookmark;
+                if (type === "embed")
+                    blockContent = block.embed;
+                if (type === "link_preview")
+                    blockContent = block.link_preview;
+                if (blockContent)
+                    return md.link(type, blockContent.url);
+                break;
+            }
+            // Rest of the types
+            // "paragraph"
+            // "heading_1"
+            // "heading_2"
+            // "heading_3"
+            // "bulleted_list_item"
+            // "numbered_list_item"
+            // "quote"
+            // "to_do"
+            // "toggle"
+            // "template"
+            // "synced_block"
+            // "child_page"
+            // "child_database"
+            // "code"
+            // "callout"
+            // "breadcrumb"
+            // "table_of_contents"
+            // "column_list"
+            // "column"
+            // "link_to_page"
+            // "audio"
+            // "unsupported"
+            default: {
+                // In this case typescript is not able to index the types properly, hence ignoring the error
+                // @ts-ignore
+                let blockContent = block[type].text || [];
+                blockContent.map((content) => {
+                    const annotations = content.annotations;
+                    let plain_text = content.plain_text;
+                    plain_text = this.annotatePlainText(plain_text, annotations);
+                    if (content["href"])
+                        plain_text = md.link(plain_text, content["href"]);
+                    parsedData += plain_text;
+                });
+            }
+        }
+        switch (type) {
+            case "code": {
+                parsedData = md.codeBlock(parsedData, block[type].language);
+                break;
+            }
+            case "heading_1": {
+                parsedData = md.heading1(parsedData);
+                break;
+            }
+            case "heading_2": {
+                parsedData = md.heading2(parsedData);
+                break;
+            }
+            case "heading_3": {
+                parsedData = md.heading3(parsedData);
+                break;
+            }
+            case "quote": {
+                parsedData = md.quote(parsedData);
+                break;
+            }
+            case "bulleted_list_item":
+            case "numbered_list_item": {
+                parsedData = md.bullet(parsedData);
+                break;
+            }
+            case "to_do": {
+                parsedData = md.todo(parsedData, block.to_do.checked);
+                break;
+            }
+        }
+        return parsedData;
+    }
+    /**
+     * Annoate text using provided annotations
+     * @param {string} text - String to be annotated
+     * @param {Annotations} annotations - Annotation object of a notion block
+     * @returns {string} - Annotated text
+     */
+    annotatePlainText(text, annotations) {
+        // if text is all spaces, don't annotate
+        if (text.match(/^\s*$/))
+            return text;
+        const leadingSpaceMatch = text.match(/^(\s*)/);
+        const trailingSpaceMatch = text.match(/(\s*)$/);
+        const leading_space = leadingSpaceMatch ? leadingSpaceMatch[0] : "";
+        const trailing_space = trailingSpaceMatch ? trailingSpaceMatch[0] : "";
+        text = text.trim();
+        if (text !== "") {
+            if (annotations.code)
+                text = md.inlineCode(text);
+            if (annotations.bold)
+                text = md.bold(text);
+            if (annotations.italic)
+                text = md.italic(text);
+            if (annotations.strikethrough)
+                text = md.strikethrough(text);
+            if (annotations.underline)
+                text = md.underline(text);
+        }
+        return leading_space + text + trailing_space;
+    }
+}
+exports.NotionToMarkdown = NotionToMarkdown;
+//# sourceMappingURL=notion-to-md.js.map

package/build/notion-to-md.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notion-to-md.js","sourceRoot":"","sources":["../src/notion-to-md.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AASA,+CAAiC;AACjC,2CAAkD;AAElD;;GAEG;AACH,MAAa,gBAAgB;IAG3B,YAAY,OAAiC;QAC3C,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,WAAsB,EAAE,EAAE,eAAuB,CAAC;QACjE,IAAI,QAAQ,GAAG,EAAE,CAAC;QAClB,QAAQ,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC5B,IAAI,QAAQ,CAAC,MAAM,EAAE;gBACnB,QAAQ,IAAI;EAClB,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;CAC9C,CAAC;aACK;YACD,IAAI,QAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;gBACrD,QAAQ,IAAI,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,QAAQ,EAAE,YAAY,GAAG,CAAC,CAAC,CAAC;aACxE;QACH,CAAC,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,EAAU,EAAE,YAAoB,CAAC;QACpD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACtB,MAAM,IAAI,KAAK,CACb,wGAAwG,CACzG,CAAC;SACH;QACD,IAAI,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QACrE,MAAM,MAAM,GAAG,MAAM,IAAA,yBAAgB,EAAC,IAAI,CAAC,YAAY,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC;QACxE,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACvD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CACpB,MAAyC,EACzC,YAAoB,CAAC,EACrB,WAAsB,EAAE;QAExB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACtB,MAAM,IAAI,KAAK,CACb,wGAAwG,CACzG,CAAC;SACH;QAED,IAAI,CAAC,MAAM;YAAE,OAAO,QAAQ,CAAC;QAE7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACtC,IAAI,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,cAAc,IAAI,KAAK,IAAI,KAAK,CAAC,YAAY,EAAE;gBACjD,IAAI,YAAY,GAAG,MAAM,IAAA,yBAAgB,EACvC,IAAI,CAAC,YAAY,EACjB,KAAK,CAAC,EAAE,EACR,SAAS,CACV,CAAC;gBACF,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;gBAErE,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC;gBACxB,MAAM,IAAI,CAAC,gBAAgB,CACzB,YAAY,EACZ,SAAS,EACT,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CACzB,CAAC;gBACF,SAAS;aACV;YACD,IAAI,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YAEtC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;SAC9C;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,KAAsC;QACpD,IAAI,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QAElC,IAAI,UAAU,GAAG,EAAE,CAAC;QACpB,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QAEvB,QAAQ,IAAI,EAAE;YACZ,KAAK,OAAO,CAAC,CAAC;gBACZ,IAAI,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC;gBAC/B,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC;gBACrC,IAAI,UAAU,KAAK,UAAU;oBAC3B,OAAO,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBACtD,IAAI,UAAU,KAAK,MAAM;oBACvB,OAAO,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAClD,MAAM;aACP;YACD,KAAK,SAAS,CAAC,CAAC;gBACd,OAAO,EAAE,CAAC,OAAO,EAAE,CAAC;aACrB;YACD,KAAK,UAAU,CAAC,CAAC;gBACf,OAAO,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;aAChD;YACD,KAAK,OAAO,CAAC;YACb,KAAK,MAAM,CAAC;YACZ,KAAK,KAAK,CAAC,CAAC;gBACV,IAAI,YAAY,CAAC;gBACjB,IAAI,IAAI,KAAK,OAAO;oBAAE,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC;gBACjD,IAAI,IAAI,KAAK,MAAM;oBAAE,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC;gBAC/C,IAAI,IAAI,KAAK,KAAK;oBAAE,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC;gBAC7C,IAAI,YAAY,EAAE;oBAChB,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC;oBACpC,IAAI,SAAS,KAAK,UAAU;wBAC1B,OAAO,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;oBACrD,IAAI,SAAS,KAAK,MAAM;wBACtB,OAAO,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;iBAClD;gBACD,MAAM;aACP;YACD,KAAK,UAAU,CAAC;YAChB,KAAK,OAAO,CAAC;YACb,KAAK,cAAc,CAAC,CAAC;gBACnB,IAAI,YAAY,CAAC;gBACjB,IAAI,IAAI,KAAK,UAAU;oBAAE,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC;gBACvD,IAAI,IAAI,KAAK,OAAO;oBAAE,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC;gBACjD,IAAI,IAAI,KAAK,cAAc;oBAAE,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;gBAC/D,IAAI,YAAY;oBAAE,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC;gBACzD,MAAM;aACP;YAED,oBAAoB;YACpB,cAAc;YACd,cAAc;YACd,cAAc;YACd,cAAc;YACd,uBAAuB;YACvB,uBAAuB;YACvB,UAAU;YACV,UAAU;YACV,WAAW;YACX,aAAa;YACb,iBAAiB;YACjB,eAAe;YACf,mBAAmB;YACnB,SAAS;YACT,YAAY;YACZ,eAAe;YACf,sBAAsB;YACtB,gBAAgB;YAChB,WAAW;YACX,iBAAiB;YACjB,UAAU;YACV,gBAAgB;YAChB,OAAO,CAAC,CAAC;gBACP,4FAA4F;gBAE5F,aAAa;gBACb,IAAI,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;gBAC1C,YAAY,CAAC,GAAG,CAAC,CAAC,OAAa,EAAE,EAAE;oBACjC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;oBACxC,IAAI,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;oBAEpC,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;oBAE7D,IAAI,OAAO,CAAC,MAAM,CAAC;wBACjB,UAAU,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;oBAEpD,UAAU,IAAI,UAAU,CAAC;gBAC3B,CAAC,CAAC,CAAC;aACJ;SACF;QAED,QAAQ,IAAI,EAAE;YACZ,KAAK,MAAM,CAAC,CAAC;gBACX,UAAU,GAAG,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC;gBAC5D,MAAM;aACP;YACD,KAAK,WAAW,CAAC,CAAC;gBAChB,UAAU,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACrC,MAAM;aACP;YACD,KAAK,WAAW,CAAC,CAAC;gBAChB,UAAU,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACrC,MAAM;aACP;YACD,KAAK,WAAW,CAAC,CAAC;gBAChB,UAAU,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACrC,MAAM;aACP;YACD,KAAK,OAAO,CAAC,CAAC;gBACZ,UAAU,GAAG,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBAClC,MAAM;aACP;YACD,KAAK,oBAAoB,CAAC;YAC1B,KAAK,oBAAoB,CAAC,CAAC;gBACzB,UAAU,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;gBACnC,MAAM;aACP;YACD,KAAK,OAAO,CAAC,CAAC;gBACZ,UAAU,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACtD,MAAM;aACP;SACF;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CAAC,IAAY,EAAE,WAAwB;QACtD,wCAAwC;QACxC,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;YAAE,OAAO,IAAI,CAAC;QAErC,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC/C,MAAM,kBAAkB,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEhD,MAAM,aAAa,GAAG,iBAAiB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACpE,MAAM,cAAc,GAAG,kBAAkB,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAEvE,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAEnB,IAAI,IAAI,KAAK,EAAE,EAAE;YACf,IAAI,WAAW,CAAC,IAAI;gBAAE,IAAI,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACjD,IAAI,WAAW,CAAC,IAAI;gBAAE,IAAI,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,WAAW,CAAC,MAAM;gBAAE,IAAI,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC/C,IAAI,WAAW,CAAC,aAAa;gBAAE,IAAI,GAAG,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC7D,IAAI,WAAW,CAAC,SAAS;gBAAE,IAAI,GAAG,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;SACtD;QAED,OAAO,aAAa,GAAG,IAAI,GAAG,cAAc,CAAC;IAC/C,CAAC;CACF;AA1PD,4CA0PC","sourcesContent":["import { Client } from \"@notionhq/client\";\nimport {\n  Annotations,\n  ListBlockChildrenResponseResult,\n  ListBlockChildrenResponseResults,\n  MdBlock,\n  Text,\n  NotionToMarkdownOptions,\n} from \"./types\";\nimport * as md from \"./utils/md\";\nimport { getBlockChildren } from \"./utils/notion\";\n\n/**\n * Converts a Notion page to Markdown.\n */\nexport class NotionToMarkdown {\n  private notionClient?: Client;\n\n  constructor(options?: NotionToMarkdownOptions) {\n    this.notionClient = options ? options.notionClient : undefined;\n  }\n\n  /**\n   * Converts Markdown Blocks to string\n   * @param {MdBlock[]} mdBlocks - Array of markdown blocks\n   * @param {number} nestingLevel - Defines max depth of nesting\n   * @returns {string} - Returns markdown string\n   */\n  toMarkdownString(mdBlocks: MdBlock[] = [], nestingLevel: number = 0): string {\n    let mdString = \"\";\n    mdBlocks.forEach((mdBlocks) => {\n      if (mdBlocks.parent) {\n        mdString += `\n${md.addTabSpace(mdBlocks.parent, nestingLevel)}\n`;\n      }\n      if (mdBlocks.children && mdBlocks.children.length > 0) {\n        mdString += this.toMarkdownString(mdBlocks.children, nestingLevel + 1);\n      }\n    });\n    return mdString;\n  }\n\n  /**\n   * Retrieves Notion Blocks based on ID and converts them to Markdown Blocks\n   * @param {string} id - notion page id (not database id)\n   * @param {number} totalPage - Retrieve block children request number, page_size Maximum = totalPage * 100 (Default=1)\n   * @returns {Promise<MdBlock[]>} - List of markdown blocks\n   */\n  async pageToMarkdown(id: string, totalPage: number = 1): Promise<MdBlock[]> {\n    if (!this.notionClient) {\n      throw new Error(\n        \"notion client is not provided, for more details check out https://github.com/souvikinator/notion-to-md\"\n      );\n    }\n    if (!id) throw new Error(\"pageToMarkdown takes page_id as argument\");\n    const blocks = await getBlockChildren(this.notionClient, id, totalPage);\n    const parsedData = await this.blocksToMarkdown(blocks);\n    return parsedData;\n  }\n\n  /**\n   * Converts list of Notion Blocks to Markdown Blocks\n   * @param {ListBlockChildrenResponseResults | undefined} blocks - List of notion blocks\n   * @param {number} totalPage - Retrieve block children request number, page_size Maximum = totalPage * 100\n   * @param {MdBlock[]} mdBlocks - Defines max depth of nesting\n   * @returns {Promise<MdBlock[]>} - Array of markdown blocks with their children\n   */\n  async blocksToMarkdown(\n    blocks?: ListBlockChildrenResponseResults,\n    totalPage: number = 1,\n    mdBlocks: MdBlock[] = []\n  ): Promise<MdBlock[]> {\n    if (!this.notionClient) {\n      throw new Error(\n        \"notion client is not provided, for more details check out https://github.com/souvikinator/notion-to-md\"\n      );\n    }\n\n    if (!blocks) return mdBlocks;\n\n    for (let i = 0; i < blocks.length; i++) {\n      let block = blocks[i];\n      if (\"has_children\" in block && block.has_children) {\n        let child_blocks = await getBlockChildren(\n          this.notionClient,\n          block.id,\n          totalPage\n        );\n        mdBlocks.push({ parent: this.blockToMarkdown(block), children: [] });\n\n        let l = mdBlocks.length;\n        await this.blocksToMarkdown(\n          child_blocks,\n          totalPage,\n          mdBlocks[l - 1].children\n        );\n        continue;\n      }\n      let tmp = this.blockToMarkdown(block);\n\n      mdBlocks.push({ parent: tmp, children: [] });\n    }\n    return mdBlocks;\n  }\n\n  /**\n   * Converts a Notion Block to a Markdown Block\n   * @param {ListBlockChildrenResponseResult} block - single notion block\n   * @returns {string} corresponding markdown string of the passed block\n   */\n  blockToMarkdown(block: ListBlockChildrenResponseResult): string {\n    if (!(\"type\" in block)) return \"\";\n\n    let parsedData = \"\";\n    const { type } = block;\n\n    switch (type) {\n      case \"image\": {\n        let blockContent = block.image;\n        const image_type = blockContent.type;\n        if (image_type === \"external\")\n          return md.image(\"image\", blockContent.external.url);\n        if (image_type === \"file\")\n          return md.image(\"image\", blockContent.file.url);\n        break;\n      }\n      case \"divider\": {\n        return md.divider();\n      }\n      case \"equation\": {\n        return md.codeBlock(block.equation.expression);\n      }\n      case \"video\":\n      case \"file\":\n      case \"pdf\": {\n        let blockContent;\n        if (type === \"video\") blockContent = block.video;\n        if (type === \"file\") blockContent = block.file;\n        if (type === \"pdf\") blockContent = block.pdf;\n        if (blockContent) {\n          const file_type = blockContent.type;\n          if (file_type === \"external\")\n            return md.link(\"image\", blockContent.external.url);\n          if (file_type === \"file\")\n            return md.link(\"image\", blockContent.file.url);\n        }\n        break;\n      }\n      case \"bookmark\":\n      case \"embed\":\n      case \"link_preview\": {\n        let blockContent;\n        if (type === \"bookmark\") blockContent = block.bookmark;\n        if (type === \"embed\") blockContent = block.embed;\n        if (type === \"link_preview\") blockContent = block.link_preview;\n        if (blockContent) return md.link(type, blockContent.url);\n        break;\n      }\n\n      // Rest of the types\n      // \"paragraph\"\n      // \"heading_1\"\n      // \"heading_2\"\n      // \"heading_3\"\n      // \"bulleted_list_item\"\n      // \"numbered_list_item\"\n      // \"quote\"\n      // \"to_do\"\n      // \"toggle\"\n      // \"template\"\n      // \"synced_block\"\n      // \"child_page\"\n      // \"child_database\"\n      // \"code\"\n      // \"callout\"\n      // \"breadcrumb\"\n      // \"table_of_contents\"\n      // \"column_list\"\n      // \"column\"\n      // \"link_to_page\"\n      // \"audio\"\n      // \"unsupported\"\n      default: {\n        // In this case typescript is not able to index the types properly, hence ignoring the error\n\n        // @ts-ignore\n        let blockContent = block[type].text || [];\n        blockContent.map((content: Text) => {\n          const annotations = content.annotations;\n          let plain_text = content.plain_text;\n\n          plain_text = this.annotatePlainText(plain_text, annotations);\n\n          if (content[\"href\"])\n            plain_text = md.link(plain_text, content[\"href\"]);\n\n          parsedData += plain_text;\n        });\n      }\n    }\n\n    switch (type) {\n      case \"code\": {\n        parsedData = md.codeBlock(parsedData, block[type].language);\n        break;\n      }\n      case \"heading_1\": {\n        parsedData = md.heading1(parsedData);\n        break;\n      }\n      case \"heading_2\": {\n        parsedData = md.heading2(parsedData);\n        break;\n      }\n      case \"heading_3\": {\n        parsedData = md.heading3(parsedData);\n        break;\n      }\n      case \"quote\": {\n        parsedData = md.quote(parsedData);\n        break;\n      }\n      case \"bulleted_list_item\":\n      case \"numbered_list_item\": {\n        parsedData = md.bullet(parsedData);\n        break;\n      }\n      case \"to_do\": {\n        parsedData = md.todo(parsedData, block.to_do.checked);\n        break;\n      }\n    }\n\n    return parsedData;\n  }\n\n  /**\n   * Annoate text using provided annotations\n   * @param {string} text - String to be annotated\n   * @param {Annotations} annotations - Annotation object of a notion block\n   * @returns {string} - Annotated text\n   */\n  annotatePlainText(text: string, annotations: Annotations): string {\n    // if text is all spaces, don't annotate\n    if (text.match(/^\\s*$/)) return text;\n\n    const leadingSpaceMatch = text.match(/^(\\s*)/);\n    const trailingSpaceMatch = text.match(/(\\s*)$/);\n\n    const leading_space = leadingSpaceMatch ? leadingSpaceMatch[0] : \"\";\n    const trailing_space = trailingSpaceMatch ? trailingSpaceMatch[0] : \"\";\n\n    text = text.trim();\n\n    if (text !== \"\") {\n      if (annotations.code) text = md.inlineCode(text);\n      if (annotations.bold) text = md.bold(text);\n      if (annotations.italic) text = md.italic(text);\n      if (annotations.strikethrough) text = md.strikethrough(text);\n      if (annotations.underline) text = md.underline(text);\n    }\n\n    return leading_space + text + trailing_space;\n  }\n}\n"]}

package/build/types/index.d.ts

@@ -0,0 +1,33 @@
+import { ListBlockChildrenResponse } from "@notionhq/client/build/src/api-endpoints";
+import { Client } from "@notionhq/client";
+export declare type ListBlockChildrenResponseResults = ListBlockChildrenResponse["results"];
+export declare type ListBlockChildrenResponseResult = ListBlockChildrenResponseResults[0];
+export declare type TextRequest = string;
+export interface NotionToMarkdownOptions {
+    notionClient: Client;
+}
+export declare type MdBlock = {
+    parent: string;
+    children: MdBlock[];
+};
+export declare type Annotations = {
+    bold: boolean;
+    italic: boolean;
+    strikethrough: boolean;
+    underline: boolean;
+    code: boolean;
+    color: "default" | "gray" | "brown" | "orange" | "yellow" | "green" | "blue" | "purple" | "pink" | "red" | "gray_background" | "brown_background" | "orange_background" | "yellow_background" | "green_background" | "blue_background" | "purple_background" | "pink_background" | "red_background";
+};
+export declare type Text = {
+    type: "text";
+    text: {
+        content: string;
+        link: {
+            url: TextRequest;
+        } | null;
+    };
+    annotations: Annotations;
+    plain_text: string;
+    href: string | null;
+};
+//# sourceMappingURL=index.d.ts.map

package/build/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,0CAA0C,CAAC;AACrF,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,oBAAY,gCAAgC,GAC1C,yBAAyB,CAAC,SAAS,CAAC,CAAC;AAEvC,oBAAY,+BAA+B,GACzC,gCAAgC,CAAC,CAAC,CAAC,CAAC;AAEtC,oBAAY,WAAW,GAAG,MAAM,CAAC;AAEjC,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,oBAAY,OAAO,GAAG;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC;AAEF,oBAAY,WAAW,GAAG;IACxB,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;IACvB,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EACD,SAAS,GACT,MAAM,GACN,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,MAAM,GACN,QAAQ,GACR,MAAM,GACN,KAAK,GACL,iBAAiB,GACjB,kBAAkB,GAClB,mBAAmB,GACnB,mBAAmB,GACnB,kBAAkB,GAClB,iBAAiB,GACjB,mBAAmB,GACnB,iBAAiB,GACjB,gBAAgB,CAAC;CACtB,CAAC;AAEF,oBAAY,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE;YACJ,GAAG,EAAE,WAAW,CAAC;SAClB,GAAG,IAAI,CAAC;KACV,CAAC;IACF,WAAW,EAAE,WAAW,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB,CAAC"}

package/build/types/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/build/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"","sourcesContent":["import { ListBlockChildrenResponse } from \"@notionhq/client/build/src/api-endpoints\";\nimport { Client } from \"@notionhq/client\";\n\nexport type ListBlockChildrenResponseResults =\n  ListBlockChildrenResponse[\"results\"];\n\nexport type ListBlockChildrenResponseResult =\n  ListBlockChildrenResponseResults[0];\n\nexport type TextRequest = string;\n\nexport interface NotionToMarkdownOptions {\n  notionClient: Client;\n}\n\nexport type MdBlock = {\n  parent: string;\n  children: MdBlock[];\n};\n\nexport type Annotations = {\n  bold: boolean;\n  italic: boolean;\n  strikethrough: boolean;\n  underline: boolean;\n  code: boolean;\n  color:\n    | \"default\"\n    | \"gray\"\n    | \"brown\"\n    | \"orange\"\n    | \"yellow\"\n    | \"green\"\n    | \"blue\"\n    | \"purple\"\n    | \"pink\"\n    | \"red\"\n    | \"gray_background\"\n    | \"brown_background\"\n    | \"orange_background\"\n    | \"yellow_background\"\n    | \"green_background\"\n    | \"blue_background\"\n    | \"purple_background\"\n    | \"pink_background\"\n    | \"red_background\";\n};\n\nexport type Text = {\n  type: \"text\";\n  text: {\n    content: string;\n    link: {\n      url: TextRequest;\n    } | null;\n  };\n  annotations: Annotations;\n  plain_text: string;\n  href: string | null;\n};\n"]}

package/build/utils/md.d.ts

@@ -0,0 +1,17 @@
+export declare const inlineCode: (text: string) => string;
+export declare const bold: (text: string) => string;
+export declare const italic: (text: string) => string;
+export declare const strikethrough: (text: string) => string;
+export declare const underline: (text: string) => string;
+export declare const link: (text: string, href: string) => string;
+export declare const codeBlock: (text: string, language?: string | undefined) => string;
+export declare const heading1: (text: string) => string;
+export declare const heading2: (text: string) => string;
+export declare const heading3: (text: string) => string;
+export declare const quote: (text: string) => string;
+export declare const bullet: (text: string) => string;
+export declare const todo: (text: string, checked: boolean) => string;
+export declare const image: (alt: string, href: string) => string;
+export declare const addTabSpace: (text: string, n?: number) => string;
+export declare const divider: () => string;
+//# sourceMappingURL=md.d.ts.map

package/build/utils/md.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"md.d.ts","sourceRoot":"","sources":["../../src/utils/md.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU,SAAU,MAAM,WAEtC,CAAC;AAEF,eAAO,MAAM,IAAI,SAAU,MAAM,WAEhC,CAAC;AAEF,eAAO,MAAM,MAAM,SAAU,MAAM,WAElC,CAAC;AAEF,eAAO,MAAM,aAAa,SAAU,MAAM,WAEzC,CAAC;AAEF,eAAO,MAAM,SAAS,SAAU,MAAM,WAErC,CAAC;AAEF,eAAO,MAAM,IAAI,SAAU,MAAM,QAAQ,MAAM,WAE9C,CAAC;AAEF,eAAO,MAAM,SAAS,SAAU,MAAM,0CAIrC,CAAC;AAEF,eAAO,MAAM,QAAQ,SAAU,MAAM,WAEpC,CAAC;AAEF,eAAO,MAAM,QAAQ,SAAU,MAAM,WAEpC,CAAC;AAEF,eAAO,MAAM,QAAQ,SAAU,MAAM,WAEpC,CAAC;AAEF,eAAO,MAAM,KAAK,SAAU,MAAM,WAGjC,CAAC;AAEF,eAAO,MAAM,MAAM,SAAU,MAAM,WAElC,CAAC;AAEF,eAAO,MAAM,IAAI,SAAU,MAAM,WAAW,OAAO,WAElD,CAAC;AAEF,eAAO,MAAM,KAAK,QAAS,MAAM,QAAQ,MAAM,WAE9C,CAAC;AAEF,eAAO,MAAM,WAAW,SAAU,MAAM,uBAIvC,CAAC;AAEF,eAAO,MAAM,OAAO,cAEnB,CAAC"}

package/build/utils/md.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.divider = exports.addTabSpace = exports.image = exports.todo = exports.bullet = exports.quote = exports.heading3 = exports.heading2 = exports.heading1 = exports.codeBlock = exports.link = exports.underline = exports.strikethrough = exports.italic = exports.bold = exports.inlineCode = void 0;
+const inlineCode = (text) => {
+    return `\`${text}\``;
+};
+exports.inlineCode = inlineCode;
+const bold = (text) => {
+    return `**${text}**`;
+};
+exports.bold = bold;
+const italic = (text) => {
+    return `_${text}_`;
+};
+exports.italic = italic;
+const strikethrough = (text) => {
+    return `~~${text}~~`;
+};
+exports.strikethrough = strikethrough;
+const underline = (text) => {
+    return `<u>${text}</u>`;
+};
+exports.underline = underline;
+const link = (text, href) => {
+    return `[${text}](${href})`;
+};
+exports.link = link;
+const codeBlock = (text, language) => {
+    return `\`\`\`${language}
+${text}
+\`\`\``;
+};
+exports.codeBlock = codeBlock;
+const heading1 = (text) => {
+    return `# ${text}`;
+};
+exports.heading1 = heading1;
+const heading2 = (text) => {
+    return `## ${text}`;
+};
+exports.heading2 = heading2;
+const heading3 = (text) => {
+    return `### ${text}`;
+};
+exports.heading3 = heading3;
+const quote = (text) => {
+    // the replace is done to handle multiple lines
+    return `> ${text.replace(/\n/g, "  \n>")}`;
+};
+exports.quote = quote;
+const bullet = (text) => {
+    return `- ${text}`;
+};
+exports.bullet = bullet;
+const todo = (text, checked) => {
+    return checked ? `- [x] ${text}` : `- [ ] ${text}`;
+};
+exports.todo = todo;
+const image = (alt, href) => {
+    return `![${alt}](${href})`;
+};
+exports.image = image;
+const addTabSpace = (text, n = 0) => {
+    const tab = "	";
+    for (let i = 0; i < n; i++)
+        text = tab + text;
+    return text;
+};
+exports.addTabSpace = addTabSpace;
+const divider = () => {
+    return "---";
+};
+exports.divider = divider;
+//# sourceMappingURL=md.js.map