feat: add support for cover and icon

Author: alvis

source/metadata.ts

@@ -13,6 +13,8 @@
  * -------------------------------------------------------------------------
  */
 
+import { getPropertyContentFromFile } from '#property';
+
 import type { Metadata, NotionAPIDatabase, NotionAPIPage } from '#types';
 
 /**
@@ -28,6 +30,33 @@ export function getMetadata<E extends NotionAPIPage | NotionAPIDatabase>(
 
   const variable = { url, lastEditedTime };
   const invariant = { createdTime };
+  const visual = getCommonVisualMetadata(entity);
+
+  return { ...variable, ...invariant, ...visual };
+}
+
+/**
+ * get common visual properties such as cover and icon from a page or database
+ * @param entity the page or database object returned from Notion API
+ * @returns common properties
+ */
+export function getCommonVisualMetadata<
+  E extends NotionAPIPage | NotionAPIDatabase,
+>(
+  entity: E,
+): {
+  coverImage: string | null;
+  iconEmoji: string | null;
+  iconImage: string | null;
+} {
+  const { cover, icon } = entity;
 
-  return { ...variable, ...invariant };
+  return {
+    coverImage: cover ? getPropertyContentFromFile(cover) : null,
+    iconEmoji: icon?.type === 'emoji' ? icon.emoji : null,
+    iconImage:
+      icon?.type === 'external' || icon?.type === 'file'
+        ? getPropertyContentFromFile(icon)
+        : null,
+  };
 }

source/types/index.d.ts

@@ -85,6 +85,9 @@ export type Metadata = {
   url: string;
   createdTime: string;
   lastEditedTime: string;
+  coverImage: string | null;
+  iconEmoji: string | null;
+  iconImage: string | null;
 };
 
 export type Page = {

spec/client.spec.ts

@@ -15,8 +15,9 @@
 
 import assert from 'assert';
 
-import { Notion } from '#client';
+import { Notion, getCommonMetadata } from '#client';
 import { mockDatabase, mockPage } from './mock';
+import { NotionAPIPage } from '#types';
 
 describe('cl:Notion', () => {
   const client = new Notion({ token: 'token' });
@@ -71,6 +72,9 @@ title: 'Text'
 url: 'https://www.notion.so/workspace/page'
 lastEditedTime: '2020-01-01T00:00:00Z'
 createdTime: '2020-01-01T00:00:00Z'
+coverImage: 'https://www.notion.so/cover.png'
+iconEmoji: '📚'
+iconImage: null
 ---
 page-block0
 

spec/metadata.spec.ts

@@ -23,6 +23,91 @@ describe('fn:getMetadata', () => {
       createdTime: '2020-01-01T00:00:00Z',
       lastEditedTime: '2020-01-01T00:00:00Z',
       url: 'https://www.notion.so/workspace/page',
+      coverImage: 'https://www.notion.so/cover.png',
+      iconEmoji: '📚',
+      iconImage: null,
     });
   });
+
+  it('return null if no cover is set', () => {
+    expect(getMetadata({ ...examples.page, cover: null })).toEqual(
+      expect.objectContaining({ coverImage: null }),
+    );
+  });
+
+  it('return the file url if the cover is embedded', () => {
+    expect(
+      getMetadata({
+        ...examples.page,
+        cover: {
+          type: 'file',
+          file: {
+            url: 'url',
+            expiry_time: '2020-01-01T00:00:00Z',
+          },
+        },
+      }),
+    ).toEqual(expect.objectContaining({ coverImage: 'url' }));
+  });
+
+  it('return the file url if the cover is external', () => {
+    expect(
+      getMetadata({
+        ...examples.page,
+        cover: {
+          type: 'external',
+          external: {
+            url: 'url',
+          },
+        },
+      }),
+    ).toEqual(expect.objectContaining({ coverImage: 'url' }));
+  });
+
+  it('return null if no icon is set', () => {
+    expect(getMetadata({ ...examples.page, icon: null })).toEqual(
+      expect.objectContaining({ iconEmoji: null, iconImage: null }),
+    );
+  });
+
+  it('return the emoji string if the icon is set as an emoji', () => {
+    expect(
+      getMetadata({
+        ...examples.page,
+        icon: {
+          type: 'emoji',
+          emoji: '☀️',
+        },
+      }),
+    ).toEqual(expect.objectContaining({ iconEmoji: '☀️', iconImage: null }));
+  });
+
+  it('return the file url if the icon is embedded', () => {
+    expect(
+      getMetadata({
+        ...examples.page,
+        icon: {
+          type: 'file',
+          file: {
+            url: 'url',
+            expiry_time: '2020-01-01T00:00:00Z',
+          },
+        },
+      }),
+    ).toEqual(expect.objectContaining({ iconEmoji: null, iconImage: 'url' }));
+  });
+
+  it('return the file url if the icon is external', () => {
+    expect(
+      getMetadata({
+        ...examples.page,
+        icon: {
+          type: 'external',
+          external: {
+            url: 'url',
+          },
+        },
+      }),
+    ).toEqual(expect.objectContaining({ iconEmoji: null, iconImage: 'url' }));
+  });
 });

spec/node.spec.ts

@@ -52,6 +52,9 @@ function generateDatabase({
       url: `https://www.notion.so/${title.replace(' ', '-')}-${databaseID}`,
       createdTime,
       lastEditedTime,
+      coverImage: null,
+      iconEmoji: null,
+      iconImage: null,
     },
     pages,
   };
@@ -80,6 +83,9 @@ function generatePage({
       url: `https://www.notion.so/${title.replace(' ', '-')}-${pageID}`,
       createdTime,
       lastEditedTime,
+      coverImage: null,
+      iconEmoji: null,
+      iconImage: null,
     },
     markdown: '',
     blocks: [],