notion-to-md 1.0.4 → 1.0.8

package/README.md

@@ -66,6 +66,8 @@ const n2m = new notion2md({ notionClient: notion });
 
 ![output](https://imgur.com/XrUYrZ0.png)
 
+> **Note:** Details on provided methods can be found in [API section](https://github.com/souvikinator/notion-to-md#api)
+
 ### converting page to markdown object
 
 This is how the notion page looks for this example:
@@ -84,11 +86,17 @@ const notion = new Client({
 const n2m = new notion2md({ 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);
 })();
 ```
 
+> `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)).
+>
+> - 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.
+
 **Output:**
 
 ```json
@@ -167,10 +175,16 @@ const n2m = new notion2md({ notionClient: notion });
 
 ### Converting a single block to markdown string
 
-- just takes a single notion block and returns corresponding markdown string
+- only takes a single notion block and returns corresponding markdown string
 - nesting is ignored
+- not dependent on @notionhq/client
 
 ```js
+const notion2md = require("notion-to-md");
+
+// notion client not required
+const n2m = new notion2md();
+
 const result = n2m.blockToMarkdown(block);
 console.log(result);
 ```
@@ -188,26 +202,33 @@ console.log(result);
 - takes output of `pageToMarkdown` or `blocksToMarkdown` as argument
 - convert to markdown string.
 
-### `pageToMarkdown(page_id)`
+### `pageToMarkdown(page_id,totalPage)`
 
-- Takes page_id as input and converts all the blocks in the page to corresponding markdown
 - Uses `blocksToMarkdown` internally.
+- Takes `page_id` 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`.
 
-### `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)
+> `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)).
+>
+> - 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 blocks withing limit `200`.
 
-### `blocksToMarkdown(blocks)`
+### `blocksToMarkdown(blocks,totalPage)`
 
 > **Note**: requires <u>**notion-sdk-js**</u> unlike `blockToMarkdown`
 
 - `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
 
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

package/main.d.ts

@@ -0,0 +1,18 @@
+interface MdBlock {
+  parent: string;
+  children: MdBlock[];
+}
+
+declare module "notion-to-md" {
+  export default class Notion2md {
+    constructor({ notionClient }: { notionClient: any });
+    pageToMarkdown(page_id: string, totalPage: number = 1): Promise<MdBlock[]>;
+    toMarkdownString(mdBlocks: MdBlock[]): string;
+    blocksToMarkdown(
+      blocks: any,
+      mdBlocks: MdBlock[],
+      totalPage: number = 1
+    ): Promise<MdBlock[]>;
+    blockToMarkdown(block: any): string;
+  }
+}

package/notion-to-md.js

@@ -1,13 +1,12 @@
 const md = require("./utils/md");
 const { getBlockChildren } = require("./utils/notion");
-
 class notion2md {
   constructor(options) {
-    if (!options || !options.notionClient)
-      throw new Error(
-        "notion2md takes notion client as argument, for more details check out https://github.com/souvikinator/notion2md"
-      );
-    this.notionClient = options.notionClient;
+    if (!options) {
+      this.notionClient = undefined;
+    } else {
+      this.notionClient = options.notionClient || undefined;
+    }
   }
 
   toMarkdownString(mdBlocks = [], nestingLevel = 0) {
@@ -25,22 +24,36 @@ ${md.addTabSpace(mdBlocks.parent, nestingLevel)}
     return mdString;
   }
 
-  async pageToMarkdown(id) {
+  /**
+   * @param {number} totalPage - Retrieve block children request number, page_size Maximum = totalPage * 100
+   */
+  async pageToMarkdown(id, totalPage = 1) {
     if (!id) throw new Error("pageToMarkdown takes page_id as argument");
-    const blocks = await getBlockChildren(this.notionClient, id);
+    const blocks = await getBlockChildren(this.notionClient, id, totalPage);
     const parsedData = await this.blocksToMarkdown(blocks);
     return parsedData;
   }
 
   /**
    * @param {object} blocks - list of notion blocks
+   * @param {number} totalPage - Retrieve block children request number, page_size Maximum = totalPage * 100
    * @returns array of md blocks with their children
    */
-  async blocksToMarkdown(blocks, mdBlocks = []) {
+  async blocksToMarkdown(blocks, mdBlocks = [], 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"
+      );
+    }
+
     for (let i = 0; i < blocks.length; i++) {
       let block = blocks[i];
       if (block.has_children) {
-        let child_blocks = await getBlockChildren(this.notionClient, block.id);
+        let child_blocks = await getBlockChildren(
+          this.notionClient,
+          block.id,
+          totalPage
+        );
         mdBlocks.push({ parent: this.blockToMarkdown(block), children: [] });
         let l = mdBlocks.length;
         await this.blocksToMarkdown(child_blocks, mdBlocks[l - 1].children);
@@ -58,6 +71,8 @@ ${md.addTabSpace(mdBlocks.parent, nestingLevel)}
    * @returns markdown form of the passed block
    */
   blockToMarkdown(block) {
+    if (!block) throw new Error("notion block required");
+
     let parsedData = "",
       blockContent;
     const { type } = block;
@@ -97,7 +112,8 @@ ${md.addTabSpace(mdBlocks.parent, nestingLevel)}
       });
     }
 
-    if (type === "code") parsedData = md.codeBlock(parsedData);
+    if (type === "code")
+      parsedData = md.codeBlock(parsedData, block[type].language);
     if (type === "heading_1") parsedData = md.heading1(parsedData);
     if (type === "heading_2") parsedData = md.heading2(parsedData);
     if (type === "heading_3") parsedData = md.heading3(parsedData);
@@ -116,13 +132,19 @@ ${md.addTabSpace(mdBlocks.parent, nestingLevel)}
    * @param {object} annotations annotation object of a notion block
    */
   annotatePlainText(text, annotations) {
-    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);
+    const leading_space = text.match(/^\s*/)[0];
+    const trailing_space = text.match(/\s*$/)[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 text;
+    return leading_space + text + trailing_space;
   }
 }
 

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "notion-to-md",
-  "version": "1.0.4",
-  "main": "notion-to-md.js",
+  "version": "1.0.8",
+  "main": "main.js",
+  "typings": "main.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -24,5 +25,8 @@
     "url": "https://github.com/souvikinator/notion-to-md/issues"
   },
   "homepage": "https://github.com/souvikinator/notion-to-md#readme",
-  "description": "convert notion pages, block and list of blocks to markdown (supports nesting)"
+  "description": "convert notion pages, block and list of blocks to markdown (supports nesting)",
+  "dependencies": {
+    "@notionhq/client": "^0.4.11"
+  }
 }

package/utils/md.js

@@ -22,8 +22,8 @@ exports.link = (text, href) => {
   return `[${text}](${href})`;
 };
 
-exports.codeBlock = (text) => {
-  return `\`\`\`
+exports.codeBlock = (text, language) => {
+  return `\`\`\`${language}
 ${text}
 \`\`\``;
 };
@@ -41,7 +41,8 @@ exports.heading3 = (text) => {
 };
 
 exports.quote = (text) => {
-  return `| ${text}`;
+  // the replace is done to handle multiple lines
+  return `> ${text.replace(/\n/g, "  \n>")}`;
 };
 
 exports.bullet = (text) => {

package/utils/notion.js

@@ -1,9 +1,33 @@
-exports.getBlockChildren = async (notionClient, block_id) => {
+exports.getBlockChildren = async (notionClient, block_id, totalPage) => {
   try {
-    const response = await notionClient.blocks.children.list({
-      block_id,
-    });
-    return response.results;
+    if (!notionClient) {
+      throw new Error(
+        "notion client is not provided, for more details check out https://github.com/souvikinator/notion-to-md"
+      );
+    }
+    let result = [];
+    let start_cursor;
+    let pageSize = 100;
+    for (i = 0; i < totalPage; i++) {
+      // contain start_cursor
+      const response = await notionClient.blocks.children.list({
+        start_cursor: start_cursor,
+        page_size: pageSize,
+        block_id: block_id,
+      });
+      let current = response.results;
+      // delete start_cursor
+      if (start_cursor) {
+        current.shift();
+      }
+      result.push(...current);
+      if (current.length < 100) {
+        break;
+      }
+      pageSize = 101;
+      start_cursor = current[current.length - 1].id;
+    }
+    return result;
   } catch (e) {
     console.log(e);
   }