Editor

import { InkKitEditor } from '@aicayzer/inkkit/core'
import '@aicayzer/inkkit/style.css'

type DocumentFormat = 'md' | 'txt'

interface DocumentVersion {
  documentId: string
  generation: number
  revision: number
}

interface DocumentInput {
  documentId: string // The host's name. Inkkit never interprets it.
  generation: number // An integer greater than the loaded generation.
  format: DocumentFormat // 'txt' is literal text with no formatted mode.
  text: string // The complete text. '' is an empty document.
}

import type { DocumentInput, DocumentVersion } from '@aicayzer/inkkit'

interface DocumentSnapshot extends DocumentInput, DocumentVersion {
  dirty: boolean // The text differs from the text of the last load.
}

import type { DocumentVersion } from '@aicayzer/inkkit'

interface Heading extends Readonly<DocumentVersion> {
  readonly id: string // Opaque. Belongs to this load, revision and editing mode.
  readonly level: number // 1 to 6.
  readonly text: string // Readable text, without author comments.
}

interface ImageInsertion {
  reference: string // Written as the image's Markdown destination.
  alt: string
  title?: string
}

import type { DocumentVersion, PortableImage } from '@aicayzer/inkkit'

interface ClipboardOutput extends DocumentVersion {
  text: string // Readable plain text.
  html: string // Semantic HTML with no private image URL.
  markdown: string // The scope's Markdown source. A whole document gives its exact source.
  images: ClipboardImage[] // The images in html, in order.
  diagrams: ClipboardDiagram[] // Each complete Mermaid diagram in the scope.
}

interface ClipboardImage {
  reference: string // The authored reference. Empty for the picture of a diagram.
  alt: string
  image?: PortableImage
  error?: string // Why image is missing.
}

interface ClipboardDiagram {
  source: string
  image?: PortableImage // A PNG of the rendered diagram.
  error?: string // Why image is missing. The source is still in the output.
}

import type { CapturedImage } from '@aicayzer/inkkit'

interface ClipboardInput {
  text: string
  markdown?: string // Explicit Markdown. Takes precedence over text and html.
  html?: string
  images?: CapturedImage[] // Bytes for the images that html refers to.
}

import type {
  DocumentFormat,
  DocumentVersion,
  PortableImage,
} from '@aicayzer/inkkit'

interface PrintableDocument extends DocumentVersion {
  format: DocumentFormat
  html: string // A complete HTML document with the print CSS embedded and data: images only.
  styles: string // The print CSS on its own.
  assets: readonly PortableImage[] // The images, in the order they appear in html.
  warnings: readonly PrintableWarning[]
}

interface PrintableWarning {
  code: 'diagram-unavailable' | 'attachment-fallback' | 'attachment-unavailable'
  message: string
}

import type { DocumentFormat, DocumentVersion } from '@aicayzer/inkkit'

interface ReadableTextSnapshot extends DocumentVersion {
  snapshotId: string // Opaque, and local to this editor.
  format: DocumentFormat
  mode: 'source' | 'formatted'
  text: string
  selection: TextRange
}

interface TextRange {
  snapshotId: string
  from: number // Zero-based UTF-16 offset in the snapshot's text.
  to: number // Exclusive.
}

interface TextRect {
  left: number
  top: number
  right: number
  bottom: number
  width: number
  height: number
}

interface ViewportInsets {
  top: number
  right: number
  bottom: number
  left: number
}

interface ViewportOptions {
  scrollContainer?: HTMLElement // Defaults to the root.
  insets?: Partial<ViewportInsets> // CSS pixels. Each side defaults to 0.
}

import type { TextRect, ViewportInsets } from '@aicayzer/inkkit'

interface ViewportSnapshot {
  rect: TextRect // The visible area of the container, root and window, less the insets.
  insets: ViewportInsets
  scrollTop: number // The container's offset plus, in source and TXT modes, the textarea's.
  scrollLeft: number
}

interface KeyInput {
  key: string // KeyboardEvent.key, such as 'Enter' or 'b'.
  code?: string // KeyboardEvent.code, such as 'KeyB'.
  metaKey?: boolean // An omitted modifier isn't held.
  ctrlKey?: boolean
  altKey?: boolean
  shiftKey?: boolean
}