rabbit / src / types / leaflet.ts

/**
 * Leaflet types based on the pub.leaflet lexicon.
 * Leaflet is a tool for shared writing and social publishing on the AT Protocol.
 */

import type { AtUri, BlueskyPost, BlueskyProfile, Did, Timestamp } from './atproto'

/**
 * Strong reference to an AT Protocol record (com.atproto.repo.strongRef)
 */
export interface StrongRef {
  uri: AtUri
  cid: string
}

/**
 * Text alignment options for blocks
 */
export type TextAlignment = 'left' | 'center' | 'right' | 'justify'

/**
 * Position within a document for quotes/selections
 */
export interface LeafletPosition {
  block: number[]
  offset: number
}

/**
 * Quote/selection range in a document
 */
export interface LeafletQuote {
  start: LeafletPosition
  end: LeafletPosition
}

/**
 * Rich text facet (pub.leaflet.richtext.facet)
 * Note: This is a placeholder - actual structure depends on the facet lexicon
 */
export interface LeafletFacet {
  index: {
    byteStart: number
    byteEnd: number
  }
  features: Array<{
    $type: string
    [key: string]: unknown
  }>
}

/**
 * Base block wrapper that contains a union of block types
 */
export interface LeafletBlockWrapper {
  block: LeafletBlock
  alignment?: TextAlignment
}

/**
 * Union type for all possible Leaflet blocks
 */
export type LeafletBlock =
  | LeafletBlockIframe
  | LeafletBlockText
  | LeafletBlockBlockquote
  | LeafletBlockHeader
  | LeafletBlockImage
  | LeafletBlockUnorderedList
  | LeafletBlockWebsite
  | LeafletBlockMath
  | LeafletBlockCode
  | LeafletBlockHorizontalRule
  | LeafletBlockBskyPost
  | LeafletBlockPage
  | LeafletBlockPoll
  | LeafletBlockButton

/**
 * Text block (pub.leaflet.blocks.text)
 */
export interface LeafletBlockText {
  $type: 'pub.leaflet.blocks.text'
  plaintext: string
  facets?: LeafletFacet[]
}

/**
 * Blockquote block (pub.leaflet.blocks.blockquote)
 */
export interface LeafletBlockBlockquote {
  $type: 'pub.leaflet.blocks.blockquote'
  plaintext: string
  facets?: LeafletFacet[]
}

/**
 * Header block (pub.leaflet.blocks.header)
 */
export interface LeafletBlockHeader {
  $type: 'pub.leaflet.blocks.header'
  level?: number
  plaintext: string
  facets?: LeafletFacet[]
}

/**
 * Code block (pub.leaflet.blocks.code)
 */
export interface LeafletBlockCode {
  $type: 'pub.leaflet.blocks.code'
  plaintext: string
  language?: string
  syntaxHighlightingTheme?: string
}

/**
 * Unordered list block (pub.leaflet.blocks.unorderedList)
 */
export interface LeafletBlockUnorderedList {
  $type: 'pub.leaflet.blocks.unorderedList'
  children: LeafletListItem[]
}

export interface LeafletListItem {
  content: LeafletBlockText | LeafletBlockHeader | LeafletBlockImage
  children?: LeafletListItem[]
}

/**
 * Website block (pub.leaflet.blocks.website)
 */
export interface LeafletBlockWebsite {
  $type: 'pub.leaflet.blocks.website'
  src: string
  previewImage?: string
  title?: string
  description?: string
}

/**
 * Math block (pub.leaflet.blocks.math)
 */
export interface LeafletBlockMath {
  $type: 'pub.leaflet.blocks.math'
  tex: string
}

/**
 * Horizontal rule block (pub.leaflet.blocks.horizontalRule)
 */
export interface LeafletBlockHorizontalRule {
  $type: 'pub.leaflet.blocks.horizontalRule'
}

/**
 * Bluesky post block (pub.leaflet.blocks.bskyPost)
 */
export interface LeafletBlockBskyPost {
  $type: 'pub.leaflet.blocks.bskyPost'
  postRef: StrongRef
}

/**
 * Poll block (pub.leaflet.blocks.poll)
 */
export interface LeafletBlockPoll {
  $type: 'pub.leaflet.blocks.poll'
  pollRef: StrongRef
}

/**
 * Iframe block (pub.leaflet.blocks.iframe)
 * Note: Structure not fully defined, placeholder
 */
export interface LeafletBlockIframe {
  $type: 'pub.leaflet.blocks.iframe'
  [key: string]: unknown
}

/**
 * Image block (pub.leaflet.blocks.image)
 * Note: Structure not fully defined, placeholder
 */
export interface LeafletBlockImage {
  $type: 'pub.leaflet.blocks.image'
  [key: string]: unknown
}

/**
 * Page block (pub.leaflet.blocks.page)
 * Note: Structure not fully defined, placeholder
 */
export interface LeafletBlockPage {
  $type: 'pub.leaflet.blocks.page'
  [key: string]: unknown
}

/**
 * Button block (pub.leaflet.blocks.button)
 * Note: Structure not fully defined, placeholder
 */
export interface LeafletBlockButton {
  $type: 'pub.leaflet.blocks.button'
  [key: string]: unknown
}

/**
 * Leaflet Linear Document (pub.leaflet.pages.linearDocument)
 * This is the main document type that contains an array of blocks.
 */
export interface LeafletLinearDoc {
  /** The URI of this document (if stored as an AT Protocol record) */
  uri?: AtUri
  /** The CID of this document record */
  cid?: string
  /** Optional document ID */
  id?: string
  /** Array of blocks that make up the document */
  blocks: LeafletBlockWrapper[]
  /** The author of the document */
  author?: BlueskyProfile
  /** When the document was created */
  createdAt?: Timestamp
  /** When the document was last updated */
  updatedAt?: Timestamp
  /** Reply information (if this is a reply) */
  replyCount?: number
  repostCount?: number
  likeCount?: number
  quoteCount?: number
  /** When this document record was indexed */
  indexedAt?: Timestamp
}

/**
 * Union type for thread posts - can be either a LeafletLinearDoc or BlueskyPost
 */
export type ThreadPost = LeafletLinearDoc | BlueskyPost

/**
 * Thread view that can contain mixed post types
 */
export interface LeafletThreadView {
  root: LeafletLinearDoc
  replies?: ThreadPost[]
}