vterm.js 0.3.1 → 0.5.0

package/dist/index.d.mts

@@ -0,0 +1,106 @@
+//#region src/screen.d.ts
+/**
+ * vterm.js — Modern terminal emulator
+ *
+ * Full VT/ECMA-48/xterm standards coverage. Pure TypeScript, zero dependencies.
+ * Targets 100% of terminfo.dev's feature matrix:
+ *
+ * - All SGR attributes (bold, faint, italic, underline styles, overline, strikethrough, blink, hidden, inverse)
+ * - 16-color, 256-color, 24-bit truecolor (foreground, background, underline color)
+ * - Full cursor control (CUP, CUU/CUD/CUF/CUB, CPR, CHA, CNL, CPL, HVP, save/restore)
+ * - Cursor shape (DECSCUSR — block, underline, bar, blinking variants)
+ * - Erase operations (ED 0/1/2/3, EL 0/1/2, ECH)
+ * - Editing operations (ICH, DCH, IL, DL, REP)
+ * - Scroll regions (DECSTBM, SU, SD) with content preservation
+ * - DEC private modes (alt screen, auto-wrap, origin, insert, reverse video, bracketed paste)
+ * - Mouse tracking (X10, normal, button, any-event, SGR format)
+ * - Focus tracking (mode 1004)
+ * - Application cursor keys & keypad
+ * - Synchronized output (mode 2026)
+ * - Kitty keyboard protocol (CSI u / progressive enhancement)
+ * - Scrollback buffer with configurable limit
+ * - Wide character support (CJK, emoji ZWJ, regional indicators, VS-16)
+ * - OSC sequences (title, hyperlinks, clipboard, colors)
+ * - DCS sequences (XTVERSION, DECRQSS, XTGETTCAP, Sixel)
+ * - APC sequences (Kitty graphics protocol — parsed, query responses)
+ * - DA1/DA2/DA3 device attribute responses
+ * - DSR (device status report) responses
+ * - DECRPM (mode reporting)
+ * - Character sets (DEC Special Graphics, UTF-8)
+ * - Full C0/C1 control code handling
+ * - DECSTR soft terminal reset
+ *
+ * @see https://terminfo.dev for the feature matrix
+ * @see https://github.com/beorn/vterm for the monorepo
+ */
+interface CellColor {
+  r: number;
+  g: number;
+  b: number;
+}
+type UnderlineStyle = "none" | "single" | "double" | "curly" | "dotted" | "dashed";
+interface ScreenCell {
+  char: string;
+  fg: CellColor | null;
+  bg: CellColor | null;
+  bold: boolean;
+  faint: boolean;
+  italic: boolean;
+  underline: UnderlineStyle;
+  underlineColor: CellColor | null;
+  overline: boolean;
+  strikethrough: boolean;
+  inverse: boolean;
+  hidden: boolean;
+  blink: boolean;
+  wide: boolean;
+  url: string | null;
+}
+interface ScreenOptions {
+  cols?: number;
+  rows?: number;
+  scrollbackLimit?: number;
+  /** Callback for DA1/DA2/DSR responses — write these back to the PTY */
+  onResponse?: (data: string) => void;
+}
+interface SemanticZone {
+  type: "prompt" | "command" | "output";
+  startRow: number;
+  startCol: number;
+}
+interface SixelImage {
+  data: string;
+  row: number;
+  col: number;
+}
+interface Screen {
+  readonly cols: number;
+  readonly rows: number;
+  process(data: Uint8Array): void;
+  resize(cols: number, rows: number): void;
+  reset(): void;
+  getCell(row: number, col: number): ScreenCell;
+  getLine(row: number): ScreenCell[];
+  getText(): string;
+  getTextRange(startRow: number, startCol: number, endRow: number, endCol: number): string;
+  getCursorPosition(): {
+    x: number;
+    y: number;
+  };
+  getCursorVisible(): boolean;
+  getCursorShape(): "block" | "underline" | "bar";
+  getCursorBlinking(): boolean;
+  getTitle(): string;
+  getMode(mode: string): boolean;
+  getClipboard(): string;
+  getCwd(): string;
+  getNotifications(): string[];
+  getScrollbackLength(): number;
+  getViewportOffset(): number;
+  scrollViewport(delta: number): void;
+  getSemanticZones(): SemanticZone[];
+  getSixelImages(): SixelImage[];
+}
+declare function createScreen(options?: ScreenOptions): Screen;
+//#endregion
+export { type CellColor, type ScreenCell, type SemanticZone, type SixelImage, type UnderlineStyle, type Screen as VtermScreen, type ScreenOptions as VtermScreenOptions, createScreen as createVtermScreen };