feat: support synced blocks

Author: JohannesRudolph

README.md

@@ -46,6 +46,7 @@ The following [Notion API block object types](https://developers.notion.com/refe
 | Divider           | ✅ Yes         |                                                                                                                |
 | Table Of Contents | ❌ not planned | static site generators have their own ToC implementations                                                      |
 | Breadcrumb        | ❌ not planned | static site generators have their own nav implementations                                                      |
+| Synced Block      | ✅ Yes         | renders all children blocks                                                                                    |
 
 Support for other block types can be considered once they are available on the official Notion API.
 

src/BlockRenderer.ts

@@ -24,7 +24,7 @@ export class BlockRenderer {
     block: Block,
     assets: AssetWriter,
     context: RenderingLoggingContext
-  ): Promise<BlockRenderResult> {
+  ): Promise<BlockRenderResult | null> {
     const renderMarkdown = async (text: RichText[]) => {
       return await this.richText.renderMarkdown(text, context);
     };
@@ -98,6 +98,10 @@ export class BlockRenderer {
         const msg = `<!-- included database ${block.id} -->\n`;
         const db = await this.deferredRenderer.renderChildDatabase(block.id);
         return { lines: msg + db.markdown };
+      case "synced_block":
+        // nothing to render, only the contents of the synced block are relevant
+        // however, these are children nöpcl, and thus retrieved by recursion in RecusivveBodyRenderer
+        return null;
       case "toggle":
       case "child_page":
       case "embed":

src/Blocks.ts

@@ -35,6 +35,10 @@ export interface ChildDatabaseBlock extends BlockBase {
   type: "child_database";
 }
 
+export interface SyncedBlock extends BlockBase {
+  type: "synced_block";
+}
+
 // these are blocks that the notion API client code does not have proper typings for
 // for unknown reasons they removed types alltogether in v0.4 of the client
 // https://github.com/makenotion/notion-sdk-js/pulls?q=is%3Apr+is%3Aclosed#issuecomment-927781781
@@ -44,7 +48,8 @@ export type Block =
   | QuoteBlock
   | CalloutBlock
   | DividerBlock
-  | ChildDatabaseBlock;
+  | ChildDatabaseBlock
+  | SyncedBlock;
 
 export {
   Emoji,

src/RecursiveBodyRenderer.ts

@@ -11,12 +11,12 @@ export class RecursiveBodyRenderer {
   constructor(
     readonly publicApi: Client,
     readonly blockRenderer: BlockRenderer
-  ) { }
+  ) {}
 
   async renderBody(
     page: Page,
     assets: AssetWriter,
-    context: RenderingLoggingContext,
+    context: RenderingLoggingContext
   ): Promise<string> {
     debug("begin rendering body of page " + page.id, page.properties);
 
@@ -42,24 +42,28 @@ export class RecursiveBodyRenderer {
     assets: AssetWriter,
     context: RenderingLoggingContext
   ): Promise<string> {
-    const parentBlock = await this.blockRenderer.renderBlock(block, assets, context);
-    const parentLines = this.indent(parentBlock.lines, indent);
+    const parentBlock = await this.blockRenderer.renderBlock(
+      block,
+      assets,
+      context
+    );
+    const parentLines = parentBlock && 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 childIndent = indent + " ".repeat(parentBlock?.childIndent || 0);
     const renderChilds = children.map(
       async (x) => await this.renderBlock(x, childIndent, assets, context)
     );
     const childLines = await Promise.all(renderChilds);
 
-    return [parentLines, ...childLines].join("\n\n");
+    return [parentLines, ...childLines].filter((x) => !!x).join("\n\n");
   }
 
   private indent(content: string, indent: string) {