feat: add support for explicitly controlling child indent levels

this allows rendering toggle block contents without additional indent levels

Author: JohannesRudolph

README.md

@@ -32,7 +32,7 @@ The following [Notion API block object types](https://developers.notion.com/refe
 | Bulleted List     | ✅ Yes         |                                                                      |
 | Numbered List     | ✅ Yes         |                                                                      |
 | To do             | ✅ Yes         |                                                                      |
-| Toggle            | ❌ Missing     |                                                                      |
+| Toggle            | ✅ (Yes)       | Toggle content is included, however the toggle header is not         |
 | Code              | ✅ Yes         |                                                                      |
 | Child Pages       | ❌ not planned | avoid, they don't mix well with clear site navigation                |
 | Child Databases   | ✅ Yes         | renders as table + including child pages, inline-only tables planned |

src/BlockRenderer.ts

@@ -1,19 +1,12 @@
 import {
-  Block as PublicBlock,
-  BlockBase,
-  Emoji,
-  ExternalFile,
-  ExternalFileWithCaption,
-  File,
-  FileWithCaption,
-  ImageBlock,
-  RichText,
-} from "@notionhq/client/build/src/api-types";
-
-import { AssetWriter } from "./AssetWriter";
-import { DeferredRenderer } from "./DeferredRenderer";
-import { logger } from "./logger";
-import { RichTextRenderer } from "./RichTextRenderer";
+    Block as PublicBlock, BlockBase, Emoji, ExternalFile, ExternalFileWithCaption, File,
+    FileWithCaption, ImageBlock, RichText
+} from '@notionhq/client/build/src/api-types';
+
+import { AssetWriter } from './AssetWriter';
+import { DeferredRenderer } from './DeferredRenderer';
+import { logger } from './logger';
+import { RichTextRenderer } from './RichTextRenderer';
 
 const debug = require("debug")("blocks");
 
@@ -60,69 +53,82 @@ export type Block =
   | DividerBlock
   | ChildDatabaseBlock;
 
+
+export interface BlockRenderResult {
+  lines: string;
+  childIndent?: number;
+}
 export class BlockRenderer {
   constructor(
     private readonly richText: RichTextRenderer,
     private readonly deferredRenderer: DeferredRenderer
-  ) {}
+  ) { }
 
-  async renderBlock(block: Block, assets: AssetWriter): Promise<string> {
+  async renderBlock(block: Block, assets: AssetWriter): Promise<BlockRenderResult> {
     switch (block.type) {
       case "paragraph":
-        return await this.richText.renderMarkdown(block.paragraph.text);
+        return {
+          lines: await this.richText.renderMarkdown(block.paragraph.text)
+        }
       // note: render headings +1 level, because h1 is reserved for page titles
       case "heading_1":
-        return (
-          "## " + (await this.richText.renderMarkdown(block.heading_1.text))
-        );
+        return {
+          lines: "## " + (await this.richText.renderMarkdown(block.heading_1.text))
+        };
       case "heading_2":
-        return (
-          "### " + (await this.richText.renderMarkdown(block.heading_2.text))
-        );
+        return {
+          lines: "### " + (await this.richText.renderMarkdown(block.heading_2.text))
+        };
       case "heading_3":
-        return (
-          "#### " + (await this.richText.renderMarkdown(block.heading_3.text))
-        );
+        return {
+          lines: "#### " + (await this.richText.renderMarkdown(block.heading_3.text))
+        };
       case "bulleted_list_item":
-        return (
-          "- " +
-          (await this.richText.renderMarkdown(block.bulleted_list_item.text))
-        );
+        return {
+          lines: "- " + await this.richText.renderMarkdown(block.bulleted_list_item.text),
+          childIndent: 4
+        };
       case "numbered_list_item":
-        return (
-          "1. " +
-          (await this.richText.renderMarkdown(block.numbered_list_item.text))
-        );
+        return {
+          lines: "1. " + await this.richText.renderMarkdown(block.numbered_list_item.text),
+          childIndent: 4
+        };
       case "to_do":
-        return "[ ] " + (await this.richText.renderMarkdown(block.to_do.text));
+        return {
+          lines: "[ ] " + (await this.richText.renderMarkdown(block.to_do.text))
+        };
       case "image":
-        return await this.renderImage(block, assets);
+        return {
+          lines: await this.renderImage(block, assets)
+        }
       case "quote":
         block as any;
-        return (
-          "> " + (await this.richText.renderMarkdown((block as any).quote.text))
-        );
+        return {
+          lines: "> " + (await this.richText.renderMarkdown((block as any).quote.text))
+        };
       case "code":
-        return (
-          "```" +
-          block.code.language +
-          "\n" +
-          (await this.richText.renderMarkdown(block.code.text)) +
-          "\n```"
-        );
+        return {
+          lines:
+            "```" +
+            block.code.language +
+            "\n" +
+            (await this.richText.renderMarkdown(block.code.text)) +
+            "\n```"
+        };
       case "callout":
-        return (
-          "> " +
-          this.renderIcon(block.callout.icon) +
-          " " +
-          (await this.richText.renderMarkdown(block.callout.text))
-        );
+        return {
+          lines:
+            "> " +
+            this.renderIcon(block.callout.icon) +
+            " " +
+            (await this.richText.renderMarkdown(block.callout.text))
+        };
       case "divider":
-        return "---";
+        return { lines: "---" };
       case "child_database":
         const msg = `<!-- included database ${block.id} -->\n`;
         const db = await this.deferredRenderer.renderChildDatabase(block.id);
-        return msg + db.markdown;
+        return { lines: msg + db.markdown };
       case "toggle":
       case "child_page":
       case "embed":
@@ -133,10 +139,9 @@ export class BlockRenderer {
       case "audio":
       case "unsupported":
       default:
-        return this.renderUnsupported(
-          `unsupported block type: ${block.type}`,
-          block
-        );
+        return {
+          lines: this.renderUnsupported(`unsupported block type: ${block.type}`, block)
+        }
     }
   }
 

src/RecursiveBodyRenderer.ts

@@ -10,7 +10,7 @@ export class RecursiveBodyRenderer {
   constructor(
     readonly publicApi: Client,
     readonly blockRenderer: BlockRenderer
-  ) {}
+  ) { }
 
   async renderBody(
     page: Page,
@@ -40,18 +40,19 @@ export class RecursiveBodyRenderer {
     assets: AssetWriter
   ): Promise<string> {
     const parentBlock = await this.blockRenderer.renderBlock(block, assets);
-    const parentLines = this.indent(parentBlock, indent);
+    const parentLines = this.indent(parentBlock.lines, indent);
 
     // due to the way the Notion API is built, we need to recurisvely retrieve child
     // blocks, see https://developers.notion.com/reference/retrieve-a-block
     // "If a block contains the key has_children: true, use the Retrieve block children endpoint to get the list of children"
     const children = block.has_children
       ? (await this.publicApi.blocks.children.list({ block_id: block.id }))
-          .results
+        .results
       : [];
 
+    const childIndent = indent + " ".repeat(parentBlock.childIndent || 0);
     const renderChilds = children.map(
-      async (x) => await this.renderBlock(x, indent + "    ", assets)
+      async (x) => await this.renderBlock(x, childIndent, assets)
     );
     const childLines = await Promise.all(renderChilds);