vt100.js 0.1.0 → 0.1.1

package/README.md

@@ -17,14 +17,14 @@ Pure TypeScript VT100 terminal emulator. Zero dependencies, headless, fast.
 
 ## Comparison
 
-| Package | Screen State | SGR Colors | Scrollback | Wide Chars | Zero Deps | Size |
-|---------|:---:|:---:|:---:|:---:|:---:|:---:|
-| **vt100.js** | yes | 16/256/true | yes | yes | yes | ~30KB |
-| `@xterm/headless` | yes | 16/256/true | yes | yes | no | ~500KB |
-| `node-pty` + xterm | yes | 16/256/true | yes | yes | no | native build |
-| `ansi-parser` | no | parse only | no | no | yes | ~5KB |
-| `terminal-kit` | yes | 16/256/true | no | partial | no | ~2MB |
-| `blessed` / `neo-blessed` | yes | 16/256 | no | no | no | ~1MB |
+| Package                   | Screen State | SGR Colors  | Scrollback | Wide Chars | Zero Deps |     Size     |
+| ------------------------- | :----------: | :---------: | :--------: | :--------: | :-------: | :----------: |
+| **vt100.js**              |     yes      | 16/256/true |    yes     |    yes     |    yes    |    ~30KB     |
+| `@xterm/headless`         |     yes      | 16/256/true |    yes     |    yes     |    no     |    ~500KB    |
+| `node-pty` + xterm        |     yes      | 16/256/true |    yes     |    yes     |    no     | native build |
+| `ansi-parser`             |      no      | parse only  |     no     |     no     |    yes    |     ~5KB     |
+| `terminal-kit`            |     yes      | 16/256/true |     no     |  partial   |    no     |     ~2MB     |
+| `blessed` / `neo-blessed` |     yes      |   16/256    |     no     |     no     |    no     |     ~1MB     |
 
 ## Install
 
@@ -42,14 +42,14 @@ screen.process(new TextEncoder().encode("Hello, \x1b[1mBold\x1b[0m World!"))
 
 // Read cell state
 const cell = screen.getCell(0, 0)
-console.log(cell.char)  // "H"
+console.log(cell.char) // "H"
 
 // Read text
-console.log(screen.getText())  // "Hello, Bold World!"
+console.log(screen.getText()) // "Hello, Bold World!"
 
 // Check cursor position
 const pos = screen.getCursorPosition()
-console.log(pos)  // { x: 18, y: 0 }
+console.log(pos) // { x: 18, y: 0 }
 ```
 
 ## API
@@ -60,46 +60,46 @@ Create a new screen instance.
 
 ```typescript
 const screen = createVt100Screen({
-  cols: 80,          // terminal width
-  rows: 24,          // terminal height
-  scrollbackLimit: 1000  // max scrollback lines (default: 1000)
+  cols: 80, // terminal width
+  rows: 24, // terminal height
+  scrollbackLimit: 1000, // max scrollback lines (default: 1000)
 })
 ```
 
 ### Screen methods
 
-| Method | Description |
-|--------|-------------|
-| `process(data: Uint8Array)` | Feed raw terminal data |
-| `getText()` | Get all text (scrollback + screen) |
-| `getTextRange(startRow, startCol, endRow, endCol)` | Get text in a range |
-| `getLine(row)` | Get cells for a row |
-| `getCell(row, col)` | Get a single cell (char, fg, bg, bold, etc.) |
-| `getCursorPosition()` | Get cursor `{ x, y }` |
-| `getCursorVisible()` | Check cursor visibility |
-| `getMode(mode)` | Check terminal mode (`altScreen`, `bracketedPaste`, etc.) |
-| `getTitle()` | Get window title (set via OSC 0/2) |
-| `getScrollbackLength()` | Number of scrollback lines |
-| `getViewportOffset()` | Current viewport scroll offset |
-| `scrollViewport(delta)` | Scroll viewport by delta lines |
-| `resize(cols, rows)` | Resize the terminal |
-| `reset()` | Reset to initial state |
+| Method                                             | Description                                               |
+| -------------------------------------------------- | --------------------------------------------------------- |
+| `process(data: Uint8Array)`                        | Feed raw terminal data                                    |
+| `getText()`                                        | Get all text (scrollback + screen)                        |
+| `getTextRange(startRow, startCol, endRow, endCol)` | Get text in a range                                       |
+| `getLine(row)`                                     | Get cells for a row                                       |
+| `getCell(row, col)`                                | Get a single cell (char, fg, bg, bold, etc.)              |
+| `getCursorPosition()`                              | Get cursor `{ x, y }`                                     |
+| `getCursorVisible()`                               | Check cursor visibility                                   |
+| `getMode(mode)`                                    | Check terminal mode (`altScreen`, `bracketedPaste`, etc.) |
+| `getTitle()`                                       | Get window title (set via OSC 0/2)                        |
+| `getScrollbackLength()`                            | Number of scrollback lines                                |
+| `getViewportOffset()`                              | Current viewport scroll offset                            |
+| `scrollViewport(delta)`                            | Scroll viewport by delta lines                            |
+| `resize(cols, rows)`                               | Resize the terminal                                       |
+| `reset()`                                          | Reset to initial state                                    |
 
 ### Cell properties
 
 ```typescript
 interface ScreenCell {
-  char: string           // character content
-  fg: CellColor | null   // foreground color { r, g, b }
-  bg: CellColor | null   // background color { r, g, b }
+  char: string // character content
+  fg: CellColor | null // foreground color { r, g, b }
+  bg: CellColor | null // background color { r, g, b }
   bold: boolean
   faint: boolean
   italic: boolean
-  underline: UnderlineStyle  // "none" | "single" | "double" | "curly" | "dotted" | "dashed"
+  underline: UnderlineStyle // "none" | "single" | "double" | "curly" | "dotted" | "dashed"
   strikethrough: boolean
   inverse: boolean
   hidden: boolean
-  wide: boolean          // true for CJK/emoji double-width chars
+  wide: boolean // true for CJK/emoji double-width chars
 }
 ```
 

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { createScreen as createVt100Screen, type Screen as Vt100Screen, type ScreenOptions as Vt100ScreenOptions, type ScreenCell, type CellColor, type UnderlineStyle, } from "./screen.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,IAAI,iBAAiB,EACjC,KAAK,MAAM,IAAI,WAAW,EAC1B,KAAK,aAAa,IAAI,kBAAkB,EACxC,KAAK,UAAU,EACf,KAAK,SAAS,EACd,KAAK,cAAc,GACpB,MAAM,aAAa,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { createScreen as createVt100Screen, } from "./screen.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,IAAI,iBAAiB,GAMlC,MAAM,aAAa,CAAA"}

package/dist/screen.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Pure TypeScript VT100 terminal emulator.
+ *
+ * Inspired by the Rust vt100 crate — parses a terminal byte stream and
+ * maintains an in-memory screen representation with per-cell attributes,
+ * cursor tracking, and mode state.
+ *
+ * Zero dependencies. Handles: SGR (16/256/truecolor), cursor movement,
+ * erase, scroll regions, alternate screen, modes, OSC title, and more.
+ */
+export interface CellColor {
+    r: number;
+    g: number;
+    b: number;
+}
+export type UnderlineStyle = "none" | "single" | "double" | "curly" | "dotted" | "dashed";
+export interface ScreenCell {
+    char: string;
+    fg: CellColor | null;
+    bg: CellColor | null;
+    bold: boolean;
+    faint: boolean;
+    italic: boolean;
+    underline: UnderlineStyle;
+    strikethrough: boolean;
+    inverse: boolean;
+    hidden: boolean;
+    wide: boolean;
+}
+export interface ScreenOptions {
+    cols: number;
+    rows: number;
+    scrollbackLimit?: number;
+}
+export 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;
+    getTitle(): string;
+    getMode(mode: string): boolean;
+    getScrollbackLength(): number;
+    getViewportOffset(): number;
+    scrollViewport(delta: number): void;
+}
+export declare function createScreen(opts: ScreenOptions): Screen;
+//# sourceMappingURL=screen.d.ts.map

package/dist/screen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"screen.d.ts","sourceRoot":"","sources":["../src/screen.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAMH,MAAM,WAAW,SAAS;IACxB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACV;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAEzF,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,SAAS,GAAG,IAAI,CAAA;IACpB,EAAE,EAAE,SAAS,GAAG,IAAI,CAAA;IACpB,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE,OAAO,CAAA;IACd,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,cAAc,CAAA;IACzB,aAAa,EAAE,OAAO,CAAA;IACtB,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,IAAI,EAAE,OAAO,CAAA;CACd;AA6FD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAcD,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,CAAA;IAC/B,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACxC,KAAK,IAAI,IAAI,CAAA;IACb,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,CAAA;IAC7C,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,EAAE,CAAA;IAClC,OAAO,IAAI,MAAM,CAAA;IACjB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAA;IACxF,iBAAiB,IAAI;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7C,gBAAgB,IAAI,OAAO,CAAA;IAC3B,QAAQ,IAAI,MAAM,CAAA;IAClB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;IAC9B,mBAAmB,IAAI,MAAM,CAAA;IAC7B,iBAAiB,IAAI,MAAM,CAAA;IAC3B,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CA4gCxD"}