vt220.js 0.1.2 → 0.7.0

package/dist/index.d.mts

@@ -32,12 +32,72 @@ interface ScreenOptions {
   /** 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;
@@ -55,4 +115,4 @@ interface Screen {
 }
 declare function createScreen(opts: ScreenOptions): Screen;
 //#endregion
-export { type CellColor, type ScreenCell, type Screen as Vt220Screen, type ScreenOptions as Vt220ScreenOptions, createScreen as createVt220Screen };
+export { type CellColor, type ScreenCell, type Attrs as Vt220Attrs, type Screen as Vt220Screen, type ScreenOptions as Vt220ScreenOptions, type ScreenSnapshot as Vt220ScreenSnapshot, createScreen as createVt220Screen };

package/dist/index.mjs

@@ -724,6 +724,82 @@ function createScreen(opts) {
 			default: return false;
 		}
 	}
+	function snapshot() {
+		return structuredClone({
+			version: 1,
+			cols,
+			rows,
+			scrollbackLimit,
+			grid,
+			scrollback,
+			cursor: {
+				x: curX,
+				y: curY,
+				visible: curVisible,
+				savedX: savedCurX,
+				savedY: savedCurY
+			},
+			savedState,
+			attrs,
+			title,
+			modes: {
+				applicationCursor,
+				applicationKeypad,
+				autoWrap,
+				originMode,
+				insertMode,
+				reverseVideo
+			},
+			scrollRegion: {
+				top: scrollTop,
+				bottom: scrollBottom
+			},
+			viewportOffset,
+			parser: {
+				state: parserState,
+				escBuf,
+				oscBuf
+			}
+		});
+	}
+	function restore(value) {
+		if (typeof value !== "object" || value === null) throw new TypeError("Invalid vt220 snapshot");
+		if (value.version !== 1) throw new TypeError(`Unsupported vt220 snapshot version: ${String(value.version)}`);
+		for (const [name, n] of [
+			["cols", value.cols],
+			["rows", value.rows],
+			["scrollbackLimit", value.scrollbackLimit],
+			["viewportOffset", value.viewportOffset]
+		]) if (!Number.isInteger(n) || n < 0) throw new TypeError(`Invalid vt220 snapshot ${name}`);
+		if (!Array.isArray(value.grid) || value.grid.length !== value.rows) throw new TypeError("Invalid vt220 snapshot grid");
+		if (!Array.isArray(value.scrollback)) throw new TypeError("Invalid vt220 snapshot scrollback");
+		const copy = structuredClone(value);
+		cols = copy.cols;
+		rows = copy.rows;
+		grid = copy.grid;
+		scrollback = copy.scrollback;
+		curX = copy.cursor.x;
+		curY = copy.cursor.y;
+		curVisible = copy.cursor.visible;
+		savedCurX = copy.cursor.savedX;
+		savedCurY = copy.cursor.savedY;
+		savedState = copy.savedState;
+		attrs = copy.attrs;
+		title = copy.title;
+		applicationCursor = copy.modes.applicationCursor;
+		applicationKeypad = copy.modes.applicationKeypad;
+		autoWrap = copy.modes.autoWrap;
+		originMode = copy.modes.originMode;
+		insertMode = copy.modes.insertMode;
+		reverseVideo = copy.modes.reverseVideo;
+		scrollTop = copy.scrollRegion.top;
+		scrollBottom = copy.scrollRegion.bottom;
+		viewportOffset = copy.viewportOffset;
+		parserState = copy.parser.state;
+		escBuf = copy.parser.escBuf;
+		oscBuf = copy.parser.oscBuf;
+		clampCursor();
+	}
 	return {
 		get cols() {
 			return cols;
@@ -734,6 +810,8 @@ function createScreen(opts) {
 		process,
 		resize,
 		reset: fullReset,
+		snapshot,
+		restore,
 		getCell,
 		getLine,
 		getText,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vt220.js",
-  "version": "0.1.2",
+  "version": "0.7.0",
   "description": "VT220 terminal emulator — 8 colors, insert/delete, selective erase. Pure TypeScript, zero dependencies.",
   "keywords": [
     "ansi",
@@ -24,6 +24,8 @@
     "dist"
   ],
   "type": "module",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "exports": {
     ".": {
       "types": "./dist/index.d.mts",