vt220.js 0.1.1 → 0.1.3

package/dist/index.d.mts

@@ -0,0 +1,118 @@
+//#region src/screen.d.ts
+/**
+ * Pure TypeScript VT220 terminal emulator.
+ *
+ * Extends VT100 with VT220 features: 8 standard colors (SGR 30-37/40-47),
+ * insert/replace mode (IRM), insert/delete characters (ICH/DCH),
+ * insert/delete lines (IL/DL), erase characters (ECH), selective erase
+ * (DECSED/DECSEL), hidden/conceal (SGR 8/28), and soft reset (DECSTR).
+ *
+ * Zero dependencies. No truecolor, no 256 colors, no wide chars —
+ * those belong in vterm.js.
+ */
+interface CellColor {
+  r: number;
+  g: number;
+  b: number;
+}
+interface ScreenCell {
+  char: string;
+  fg: CellColor | null;
+  bg: CellColor | null;
+  bold: boolean;
+  underline: boolean;
+  blink: boolean;
+  inverse: boolean;
+  hidden: boolean;
+}
+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 Attrs {
+  fg: CellColor | null;
+  bg: CellColor | null;
+  bold: boolean;
+  underline: boolean;
+  blink: boolean;
+  inverse: boolean;
+  hidden: boolean;
+}
+/**
+ * Serializable VT220 screen state — the same snapshot/restore API shape as
+ * vterm.js, restricted to the documented VT220 subset. Deliberately absent:
+ * truecolor/256-color, alternate screen, mouse tracking, hyperlinks,
+ * sixel/Kitty graphics, OSC clipboard, semantic zones, wide-char shaping.
+ * Do not widen without an explicit scope decision (km bead 20667).
+ */
+interface ScreenSnapshot {
+  version: 1;
+  cols: number;
+  rows: number;
+  scrollbackLimit: number;
+  grid: ScreenCell[][];
+  scrollback: ScreenCell[][];
+  cursor: {
+    x: number;
+    y: number;
+    visible: boolean;
+    savedX: number;
+    savedY: number;
+  };
+  savedState: {
+    curX: number;
+    curY: number;
+    attrs: Attrs;
+    originMode: boolean;
+    autoWrap: boolean;
+  };
+  attrs: Attrs;
+  title: string;
+  modes: {
+    applicationCursor: boolean;
+    applicationKeypad: boolean;
+    autoWrap: boolean;
+    originMode: boolean;
+    insertMode: boolean;
+    reverseVideo: boolean;
+  };
+  scrollRegion: {
+    top: number;
+    bottom: number;
+  };
+  viewportOffset: number;
+  parser: {
+    state: "ground" | "escape" | "csi" | "osc" | "dcs" | "oscString";
+    escBuf: string;
+    oscBuf: string;
+  };
+}
+interface Screen {
+  readonly cols: number;
+  readonly rows: number;
+  process(data: Uint8Array): void;
+  resize(cols: number, rows: number): void;
+  reset(): void;
+  snapshot(): ScreenSnapshot;
+  restore(snapshot: ScreenSnapshot): 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;
+  getTitle(): string;
+  getMode(mode: string): boolean;
+  getScrollbackLength(): number;
+  getViewportOffset(): number;
+  scrollViewport(delta: number): void;
+}
+declare function createScreen(opts: ScreenOptions): Screen;
+//#endregion
+export { type CellColor, type ScreenCell, type Attrs as Vt220Attrs, type Screen as Vt220Screen, type ScreenOptions as Vt220ScreenOptions, type ScreenSnapshot as Vt220ScreenSnapshot, createScreen as createVt220Screen };