@tryfabric/martian/src/notion/blocks.ts

Converts Markdown to Notion Blocks and RichText

import {richText, supportedCodeLang} from './common';
import {AppendBlockChildrenParameters} from '@notionhq/client/build/src/api-endpoints';

export type Block = AppendBlockChildrenParameters['children'][number];
export type BlockWithoutChildren = Exclude<
  (Block & {
    type: 'paragraph';
  })['paragraph']['children'],
  undefined
>[number];
export type RichText = (Block & {
  type: 'paragraph';
})['paragraph']['rich_text'][number];

export function paragraph(text: RichText[]): Block {
  return {
    object: 'block',
    type: 'paragraph',
    paragraph: {
      rich_text: text,
    },
  };
}

export function code(
  text: RichText[],
  lang: supportedCodeLang = 'plain text'
): Block {
  return {
    object: 'block',
    type: 'code',
    code: {
      rich_text: text,
      language: lang,
    },
  };
}

export function blockquote(
  text: RichText[] = [],
  children: Block[] = []
): Block {
  return {
    object: 'block',
    type: 'quote',
    quote: {
      // By setting an empty rich text we prevent the "Empty quote" line from showing up at all
      rich_text: text.length ? text : [richText('')],
      // @ts-expect-error Typings are not perfect
      children,
    },
  };
}

export function image(url: string): Block {
  return {
    object: 'block',
    type: 'image',
    image: {
      type: 'external',
      external: {
        url: url,
      },
    },
  };
}

export function table_of_contents(): Block {
  return {
    object: 'block',
    type: 'table_of_contents',
    table_of_contents: {},
  };
}

export function headingOne(text: RichText[]): Block {
  return {
    object: 'block',
    type: 'heading_1',
    heading_1: {
      rich_text: text,
    },
  };
}

export function headingTwo(text: RichText[]): Block {
  return {
    object: 'block',
    type: 'heading_2',
    heading_2: {
      rich_text: text,
    },
  };
}

export function headingThree(text: RichText[]): Block {
  return {
    object: 'block',
    type: 'heading_3',
    heading_3: {
      rich_text: text,
    },
  };
}

export function bulletedListItem(
  text: RichText[],
  children: BlockWithoutChildren[] = []
): Block {
  return {
    object: 'block',
    type: 'bulleted_list_item',
    bulleted_list_item: {
      rich_text: text,
      children: children.length ? children : undefined,
    },
  };
}

export function numberedListItem(
  text: RichText[],
  children: BlockWithoutChildren[] = []
): Block {
  return {
    object: 'block',
    type: 'numbered_list_item',
    numbered_list_item: {
      rich_text: text,
      children: children.length ? children : undefined,
    },
  };
}

export function toDo(
  checked: boolean,
  text: RichText[],
  children: BlockWithoutChildren[] = []
): Block {
  return {
    object: 'block',
    type: 'to_do',
    to_do: {
      rich_text: text,
      checked: checked,
      children: children.length ? children : undefined,
    },
  };
}

export function table(
  children: BlockWithoutChildren[],
  tableWidth: number
): Block {
  return {
    object: 'block',
    type: 'table',
    table: {
      table_width: tableWidth,
      has_column_header: true,
      children: children?.length ? children : [],
    },
  };
}

export function tableRow(cells: RichText[][] = []): BlockWithoutChildren {
  return {
    object: 'block',
    type: 'table_row',
    table_row: {
      cells: cells.length ? cells : [],
    },
  };
}

export function equation(value: string): Block {
  return {
    type: 'equation',
    equation: {
      expression: value,
    },
  };
}