@xterm/headless 5.6.0-beta.98 → 6.0.0

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@xterm/headless",
   "description": "A headless terminal component that runs in Node.js",
-  "version": "5.6.0-beta.98",
+  "version": "6.0.0",
   "main": "lib-headless/xterm-headless.js",
   "module": "lib/xterm.mjs",
   "types": "typings/xterm-headless.d.ts",
   "repository": "https://github.com/xtermjs/xterm.js",
   "license": "MIT",
+  "workspaces": [
+    "addons/*"
+  ],
   "keywords": [
     "cli",
     "command-line",
@@ -22,5 +25,5 @@
     "webgl",
     "xterm"
   ],
-  "commit": "2042bb85023714e55c0c2e986b5000e33b17c414"
+  "commit": "f447274f430fd22513f6adbf9862d19524471c04"
 }

package/typings/xterm-headless.d.ts

@@ -186,6 +186,13 @@ declare module '@xterm/headless' {
      */
     scrollback?: number;
 
+    /**
+     * If enabled the Erase in Display All (ED2) escape sequence will push
+     * erased text to scrollback, instead of clearing only the viewport portion.
+     * This emulates PuTTY's default clear screen behavior.
+     */
+    scrollOnEraseInDisplay?: boolean;
+
     /**
      * The scrolling speed multiplier used for adjusting normal scrolling speed.
      */
@@ -826,21 +833,31 @@ declare module '@xterm/headless' {
 
     /**
      * Write data to the terminal.
+     *
+     * Note that the change will not be reflected in the {@link buffer}
+     * immediately as the data is processed asynchronously. Provide a
+     * {@link callback} to know when the data was processed.
      * @param data The data to write to the terminal. This can either be raw
      * bytes given as Uint8Array from the pty or a string. Raw bytes will always
      * be treated as UTF-8 encoded, string data as UTF-16.
      * @param callback Optional callback that fires when the data was processed
-     * by the parser.
+     * by the parser. This callback must be provided and awaited in order for
+     * {@link buffer} to reflect the change in the write.
      */
     write(data: string | Uint8Array, callback?: () => void): void;
 
     /**
      * Writes data to the terminal, followed by a break line character (\n).
+     *
+     * Note that the change will not be reflected in the {@link buffer}
+     * immediately as the data is processed asynchronously. Provide a
+     * {@link callback} to know when the data was processed.
      * @param data The data to write to the terminal. This can either be raw
      * bytes given as Uint8Array from the pty or a string. Raw bytes will always
      * be treated as UTF-8 encoded, string data as UTF-16.
      * @param callback Optional callback that fires when the data was processed
-     * by the parser.
+     * by the parser. This callback must be provided and awaited in order for
+     * {@link buffer} to reflect the change in the write.
      */
     writeln(data: string | Uint8Array, callback?: () => void): void;
 
@@ -1353,6 +1370,13 @@ declare module '@xterm/headless' {
      * Send FocusIn/FocusOut events: `CSI ? 1 0 0 4 h`
      */
     readonly sendFocusMode: boolean;
+    /**
+     * Synchronized Output Mode: `CSI ? 2 0 2 6 h`
+     *
+     * When enabled, output is buffered and only rendered when the mode is
+     * disabled, allowing for atomic screen updates without tearing.
+     */
+    readonly synchronizedOutputMode: boolean;
     /**
      * Auto-Wrap Mode (DECAWM): `CSI ? 7 h`
      */