feat: publish frontmatter in the sync() result

this makes it easier for consumers to write index files containing
the actual frontmatter data which was built from the frontmatterBuilder
functions

also align the frontmatter building for table entries so that it
works the same as for pages

Author: JohannesRudolph

src/DatabaseEntryRenderer.ts

@@ -1,16 +1,22 @@
 import { Page } from "@notionhq/client/build/src/api-types";
+import { DatabaseConfigRenderTable } from ".";
 
 import { PropertiesParser } from "./PropertiesParser";
 import { RenderDatabaseEntryTask } from "./RenderDatabaseEntryTask";
 
 export class DatabaseEntryRenderer {
   constructor(private readonly propertiesParser: PropertiesParser) {}
 
-  async renderEntry(page: Page): Promise<RenderDatabaseEntryTask> {
+  async renderEntry(
+    page: Page,
+    config: DatabaseConfigRenderTable
+  ): Promise<RenderDatabaseEntryTask> {
     const props = await this.propertiesParser.parsePageProperties(page);
+    const frontmatterProperties = config.entries?.frontmatterBuilder(props);
 
     return {
       properties: props,
+      frontmatter: frontmatterProperties,
     };
   }
 }

src/DatabasePageRenderer.ts

@@ -34,9 +34,11 @@ export class DatabasePageRenderer {
     // Design: all the rendering performance could be greatly enhanced writing directly to output streams instead
     // of concatenating all in memory. OTOH naively concatenatic strings is straightforward, easier to debug and rendering
     // performance probably not the bottleneck compared to the IO cost of notion API invocations.
+    const frontmatterProperties = config.pages.frontmatterBuilder(props);
 
     return {
       file,
+      frontmatter: frontmatterProperties,
       properties: props,
       render: async () => {
         const context = new RenderingLoggingContext(page.url, file);
@@ -51,10 +53,7 @@ export class DatabasePageRenderer {
         try {
           const assetWriter = new AssetWriter(destDir);
 
-          const frontmatter = this.frontmatterRenderer.renderFrontmatter(
-            props,
-            config
-          );
+          const frontmatter = this.frontmatterRenderer.renderFrontmatter(frontmatterProperties);
           const body = await this.bodyRenderer.renderBody(
             page,
             assetWriter,

src/DatabaseViewRenderer.spec.ts

@@ -28,7 +28,6 @@ describe("DatabaseViewRenderer", () => {
     ];
 
     const result = sut.renderViews(entries, {
-      entries: { emitToIndex: false },
       renderAs: "table",
       views: [
         {
@@ -72,7 +71,6 @@ describe("DatabaseViewRenderer", () => {
     ];
 
     const result = sut.renderViews(entries, {
-      entries: { emitToIndex: false },
       renderAs: "table",
       views: [
         {

src/DeferredRenderer.ts

@@ -62,11 +62,11 @@ export class DeferredRenderer {
     page: Page,
     config: DatabaseConfigRenderTable
   ): Promise<RenderDatabaseEntryTask> {
-    const task = await this.entryRenderer.renderEntry(page);
+    const task = await this.entryRenderer.renderEntry(page, config);
 
     // entries are complete the moment they are retrieved, there's no more deferred processing necessary on them
     // also there should be no duplicate entries, so we do not cache/lookup any of them
-    if (config.entries.emitToIndex) {
+    if (task.frontmatter) {
       this.renderedEntries.push(task);
     }
 
@@ -103,15 +103,15 @@ export class DeferredRenderer {
     ).map((x) => ({
       file: x.file,
       meta: x.properties.meta,
-      properties: x.properties.properties,
+      frontmatter: x.frontmatter,
     }));
 
     const entries: RenderedDatabaseEntry[] = this.renderedEntries.map((x) => ({
       meta: {
         id: x.properties.meta.id,
         url: x.properties.meta.url,
       },
-      properties: x.properties.properties,
+      frontmatter: x.frontmatter,
     }));
 
     return pages.concat(entries);

src/FrontmatterRenderer.ts

@@ -1,14 +1,9 @@
 import * as yaml from 'js-yaml';
-import { DatabaseConfigRenderPages } from '.';
-
-import { DatabasePageProperties } from './DatabasePageProperties';
 
 export class FrontmatterRenderer {
   constructor() {}
 
-  public renderFrontmatter(props: DatabasePageProperties, config: DatabaseConfigRenderPages) {
-    const obj = config.pages.frontmatterBuilder(props);
-
+  public renderFrontmatter(obj: Record<string, any>) {
     const frontmatter = `---\n${yaml.dump(obj)}---\n\n`;
 
     return frontmatter;

src/RenderDatabaseEntryTask.ts

@@ -2,5 +2,6 @@ import { DatabasePageProperties } from "./DatabasePageProperties";
 
 export interface RenderDatabaseEntryTask {
     properties: DatabasePageProperties
+    frontmatter?: Record<string, any>
     // note: there's nothing to do to render an individual database entry, they are always rendered as part of tables
 }

src/RenderDatabasePageTask.ts

@@ -2,5 +2,6 @@ import { RenderDatabaseEntryTask } from "./RenderDatabaseEntryTask";
 
 export interface RenderDatabasePageTask extends RenderDatabaseEntryTask {
   file: string;
+  frontmatter: Record<string, any>
   render: () => Promise<any>;
 }

src/RenderedDatabaseEntry.ts

@@ -2,5 +2,5 @@ import { DatabaseEntryMeta } from './DatabaseEntryMeta';
 
 export interface RenderedDatabaseEntry {
   meta: DatabaseEntryMeta,
-  properties: Map<string, any>;
+  frontmatter?: Record<string, any>;
 }

src/RenderedDatabasePage.ts

@@ -4,4 +4,5 @@ import { RenderedDatabaseEntry } from './RenderedDatabaseEntry';
 export interface RenderedDatabasePage extends RenderedDatabaseEntry {
   meta: DatabasePageMeta;
   file: string;
+  frontmatter: Record<string, any>;
 }

src/SyncConfig.ts

@@ -52,11 +52,12 @@ export interface DatabaseConfigRenderTable extends DatabaseConfigBase {
    */
   views?: DatabaseView[];
 
-  entries: {
+  entries?: {
     /**
-     * Controls whether to emit database entries to the index of rendered pages/entries
+     * Optional: Build frontmatter onject for index entries.
+     * If omitted, no index entries will be rendered for this table
      */
-    emitToIndex: boolean;
+     frontmatterBuilder: (props: DatabasePageProperties) => Record<string, any>;
   };
 }
 

src/config.ts

@@ -16,9 +16,6 @@ export function lookupDatabaseConfig(
   };
   const defaultDbConfig: DatabaseConfigRenderTable = {
     renderAs: "table",
-    entries: {
-      emitToIndex: false,
-    },
   };
 
   const fallbackDbConfig: DatabaseConfig =

src/index.ts

@@ -1,8 +1,12 @@
-export { RenderedDatabaseEntry } from './RenderedDatabaseEntry';
-export { RenderedDatabasePage } from './RenderedDatabasePage';
-export { sync } from './sync';
-export { slugify } from './slugify';
+export { RenderedDatabaseEntry } from "./RenderedDatabaseEntry";
+export { RenderedDatabasePage } from "./RenderedDatabasePage";
+export { sync } from "./sync";
+export { slugify } from "./slugify";
 export {
-    DatabaseConfig, DatabaseConfigRenderPages, DatabaseConfigRenderTable, SyncConfig
-} from './SyncConfig';
-
+  DatabaseConfig,
+  DatabaseConfigRenderPages,
+  DatabaseConfigRenderTable,
+  SyncConfig,
+} from "./SyncConfig";
+export { DatabasePageProperties } from "./DatabasePageProperties";
+export { DatabasePageMeta } from "./DatabasePageMeta";