add: string union for Block Type instead of string #83

souvikinator · May 20, 2023 · 2c9b9c0 · 2c9b9c0
1 parent 06a9404
commit 2c9b9c0
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 3 deletions.
diff --git a/src/notion-to-md.ts b/src/notion-to-md.ts
@@ -11,6 +11,7 @@ import {
   Text,
   ConfigurationOptions,
   MdStringObject,
+  BlockType,
 } from "./types";
 import * as md from "./utils/md";
 import { getBlockChildren } from "./utils/notion";
@@ -36,7 +37,7 @@ export class NotionToMarkdown {
   }
 
   setCustomTransformer(
-    type: string,
+    type: BlockType,
     transformer: CustomTransformer
   ): NotionToMarkdown {
     this.customTransformers[type] = transformer;

diff --git a/src/types/index.ts b/src/types/index.ts
@@ -1,11 +1,15 @@
 import { Client } from "@notionhq/client";
-import type { ListBlockChildrenResponse } from "@notionhq/client/build/src/api-endpoints";
+import type {
+  ListBlockChildrenResponse,
+  GetBlockParameters,
+} from "@notionhq/client/build/src/api-endpoints";
 
 export type BlockAttributes = {
   numbered_list_item?: {
     number?: number;
   };
 };
+
 export type ListBlockChildrenResponseResults =
   ListBlockChildrenResponse["results"] & BlockAttributes;
 
@@ -14,6 +18,46 @@ export type ListBlockChildrenResponseResult =
 
 export type TextRequest = string;
 
+export type BlockType =
+  | "image"
+  | "video"
+  | "file"
+  | "pdf"
+  | "table"
+  | "bookmark"
+  | "embed"
+  | "equation"
+  | "divider"
+  | "toggle"
+  | "to_do"
+  | "bulleted_list_item"
+  | "numbered_list_item"
+  | "synced_block"
+  | "column_list"
+  | "column"
+  | "link_preview"
+  | "link_to_page"
+  | "paragraph"
+  | "heading_1"
+  | "heading_2"
+  | "heading_3"
+  | "bulleted_list_item"
+  | "numbered_list_item"
+  | "quote"
+  | "to_do"
+  | "template"
+  | "synced_block"
+  | "child_page"
+  | "child_database"
+  | "code"
+  | "callout"
+  | "breadcrumb"
+  | "table_of_contents"
+  | "link_to_page"
+  | "audio"
+  | "unsupported"
+  | string;
+
 export type ConfigurationOptions = {
   separateChildPage?: boolean;
   convertImagesToBase64?: boolean;
@@ -98,4 +142,4 @@ export type CalloutIcon =
 
 export type CustomTransformer = (
   block: ListBlockChildrenResponseResult
-) => string | Promise<string>;
+) => BlockType | Promise<string>;