index.d.ts

import * as Notion from "notionapi-agent/dist/interfaces"

import { SemanticString } from "./SemanticString"
import { Emoji, PublicUrl, URI, UUID, TimestampNumber } from "./util"

interface Parent<T> {
  children: T[]
}

export as namespace NAST

export interface Block extends Parent<Block> {
  uri: URI
  type: string
  color?: string
  createdTime: TimestampNumber
  lastEditedTime: TimestampNumber
}

export interface Page extends Block {
  type: "page"
  title: SemanticString[]
  icon?: Emoji | PublicUrl
  cover?: PublicUrl
  fullWidth: boolean
  coverPosition: number
  properties?: {
    [key: string]: SemanticString[]
  }
}

export interface Text extends Block {
  type: "text"
  title: SemanticString[]
}

export interface ToDo extends Block {
  type: "to_do"
  title: SemanticString[]
  checked: boolean
}

export interface Heading extends Block {
  type: "heading"
  title: SemanticString[]
  depth: number
}

export interface BulletedList extends Block {
  type: "bulleted_list"
  title: SemanticString[]
}

export interface NumberedList extends Block {
  type: "numbered_list"
  title: SemanticString[]
}

export interface Toggle extends Block {
  type: "toggle"
  title: SemanticString[]
}

export interface Quote extends Block {
  type: "quote"
  title: SemanticString[]
}

export interface Divider extends Block {
  type: "divider"
}

export interface Callout extends Block {
  type: "callout"
  icon?: Emoji | PublicUrl
  title: SemanticString[]
}

/**
 * Visual content container.
 * 
 * If `width`, `height`, or `aspectRatio` is -1, 
 * it can be decided by the renderer.
 */
export interface Visual extends Block {
  type: "embed" | "pdf" | "image" | "video"
  source: PublicUrl
  caption?: SemanticString[]
  width: number
  height: number
  fullWidth: boolean
  pageWidth: boolean
  aspectRatio: number
  preserveScale: boolean
}

export interface Embed extends Visual {
  type: "embed"
}

export interface PDF extends Visual {
  type: "pdf"
}

export interface Image extends Visual {
  type: "image"
}

export interface Video extends Visual {
  type: "video"
}

export interface Audio extends Block {
  type: "audio"
  source: PublicUrl
}

export interface Bookmark extends Block {
  type: "bookmark"
  link: PublicUrl
  title?: string
  description?: string
  icon?: string
  cover?: string
}

export interface Code extends Block {
  type: "code"
  title: SemanticString[]
  language?: string
  wrap: boolean
}

export interface Equation extends Block {
  type: "equation"
  latex: string
}

/** A kind of helper for parallel layout. */
export interface ColumnList extends Block {
  type: "column_list"
  children: Column[]
}

/** A kind of helper for parallel layout. */
export interface Column extends Block {
  type: "column"
  ratio: number
}

/**
 * Collection is experimental, containing many Notion-specific stuffs.
 */
export interface Collection extends Block {
  type: "collection_inline" | "collection_page"
  name: SemanticString[]
  collectionId: UUID
  defaultViewId: UUID
  views: Notion.CollectionView[]
  schema: Notion.Collection.Schema
  children: Page[]
}

export interface CollectionInline extends Collection {
  type: "collection_inline"
}

export interface CollectionPage extends Collection {
  type: "collection_page"
  icon?: Emoji | PublicUrl
  cover?: PublicUrl
  description?: SemanticString[]
  coverPosition: number
}

export interface TableOfContents extends Block {
  type: "table_of_contents"
}

export interface BreadCrumb extends Block {
  type: "breadcrumb"
}

/** `fileId` is Notion-specific. */
export interface File extends Block {
  type: "file"
  fileId?: UUID
  title: string
  size?: string
  source: string
}

export * from "./SemanticString"
export * from "./util"