@opentui/core 0.1.6 → 0.1.7

package/3d.js

@@ -34873,7 +34873,7 @@ function getOpenTUILib(libPath) {
       returns: "ptr"
     },
     destroyRenderer: {
-      args: ["ptr"],
+      args: ["ptr", "bool", "u32"],
       returns: "void"
     },
     setUseThread: {
@@ -35028,6 +35028,14 @@ function getOpenTUILib(libPath) {
       args: ["ptr", "i64"],
       returns: "void"
     },
+    enableMouse: {
+      args: ["ptr", "bool"],
+      returns: "void"
+    },
+    disableMouse: {
+      args: ["ptr"],
+      returns: "void"
+    },
     createTextBuffer: {
       args: ["u32"],
       returns: "ptr"
@@ -35136,8 +35144,8 @@ class FFIRenderLib {
   createRenderer(width, height) {
     return this.opentui.symbols.createRenderer(width, height);
   }
-  destroyRenderer(renderer) {
-    this.opentui.symbols.destroyRenderer(renderer);
+  destroyRenderer(renderer, useAlternateScreen, splitHeight) {
+    this.opentui.symbols.destroyRenderer(renderer, useAlternateScreen, splitHeight);
   }
   setUseThread(renderer, useThread) {
     this.opentui.symbols.setUseThread(renderer, useThread);
@@ -35347,6 +35355,12 @@ class FFIRenderLib {
     const ts = timestamp ?? Date.now();
     this.opentui.symbols.dumpStdoutBuffer(renderer, ts);
   }
+  enableMouse(renderer, enableMovement) {
+    this.opentui.symbols.enableMouse(renderer, enableMovement);
+  }
+  disableMouse(renderer) {
+    this.opentui.symbols.disableMouse(renderer);
+  }
   createTextBuffer(capacity) {
     const bufferPtr = this.opentui.symbols.createTextBuffer(capacity);
     if (!bufferPtr) {
@@ -36204,7 +36218,10 @@ var ANSI = {
   enableAnyEventTracking: "\x1B[?1003h",
   disableAnyEventTracking: "\x1B[?1003l",
   enableSGRMouseMode: "\x1B[?1006h",
-  disableSGRMouseMode: "\x1B[?1006l"
+  disableSGRMouseMode: "\x1B[?1006l",
+  makeRoomForRenderer: (height) => `
+`.repeat(height) + `\x1B[${height}A`,
+  clearRendererSpace: (height) => `\x1B[${height}A\x1B[1G\x1B[J`
 };
 
 // src/console.ts
@@ -36987,6 +37004,11 @@ class MouseEvent {
     this._defaultPrevented = true;
   }
 }
+["SIGINT", "SIGTERM", "SIGQUIT", "SIGABRT"].forEach((signal) => {
+  process.on(signal, () => {
+    process.exit();
+  });
+});
 var animationFrameId = 0;
 
 class CliRenderer extends EventEmitter6 {
@@ -36996,7 +37018,6 @@ class CliRenderer extends EventEmitter6 {
   stdout;
   exitOnCtrlC;
   isDestroyed = false;
-  isShuttingDown = false;
   nextRenderBuffer;
   currentRenderBuffer;
   _isRunning = false;
@@ -37018,6 +37039,7 @@ class CliRenderer extends EventEmitter6 {
   postProcessFns = [];
   backgroundColor = RGBA.fromHex("#000000");
   waitingForPixelResolution = false;
+  shutdownRequested = null;
   rendering = false;
   renderingNative = false;
   renderTimeout = null;
@@ -37121,8 +37143,6 @@ class CliRenderer extends EventEmitter6 {
     }
     this.stdout.write = this.interceptStdoutWrite.bind(this);
     this.sigwinchHandler = () => {
-      if (this.isShuttingDown)
-        return;
       const width2 = this.stdout.columns || 80;
       const height2 = this.stdout.rows || 24;
       this.handleResize(width2, height2);
@@ -37130,6 +37150,7 @@ class CliRenderer extends EventEmitter6 {
     process.on("SIGWINCH", this.sigwinchHandler);
     const handleError = (error) => {
       this.stop();
+      this.destroy();
       new Promise((resolve2) => {
         setTimeout(() => {
           resolve2(true);
@@ -37163,8 +37184,7 @@ Error details:
     };
     process.on("uncaughtException", handleError);
     process.on("unhandledRejection", handleError);
-    process.on("exit", (code) => {
-      this.stop();
+    process.on("exit", () => {
       this.destroy();
     });
     this._console = new TerminalConsole(this, config.consoleOptions);
@@ -37183,6 +37203,13 @@ Error details:
     }
     global.window.requestAnimationFrame = requestAnimationFrame;
     this.queryPixelResolution();
+    if (process.env.OTUI_NO_NATIVE_RENDER === "true") {
+      this.renderNative = () => {
+        if (this._splitHeight > 0) {
+          this.flushStdoutCache(this._splitHeight);
+        }
+      };
+    }
   }
   writeOut(chunk, encoding, callback) {
     return this.realStdoutWrite.call(this.stdout, chunk, encoding, callback);
@@ -37314,30 +37341,17 @@ Error details:
     return true;
   }
   enableMouse() {
-    this.writeOut(ANSI.enableSGRMouseMode);
-    this.writeOut(ANSI.enableMouseTracking);
-    this.writeOut(ANSI.enableButtonEventTracking);
-    if (this.enableMouseMovement) {
-      this.writeOut(ANSI.enableAnyEventTracking);
-    }
+    this.lib.enableMouse(this.rendererPtr, this.enableMouseMovement);
   }
   disableMouse() {
-    if (this.enableMouseMovement) {
-      this.writeOut(ANSI.disableAnyEventTracking);
-    }
-    this.writeOut(ANSI.disableButtonEventTracking);
-    this.writeOut(ANSI.disableMouseTracking);
-    this.writeOut(ANSI.disableSGRMouseMode);
     this.capturedRenderable = undefined;
     this.mouseParser.reset();
+    this.lib.disableMouse(this.rendererPtr);
   }
   set useThread(useThread) {
     this._useThread = useThread;
     this.lib.setUseThread(this.rendererPtr, useThread);
   }
-  setTerminalSize(width, height) {
-    this.handleResize(width, height);
-  }
   setupTerminal() {
     this.writeOut(ANSI.saveCursorState);
     if (this.stdin.setRawMode) {
@@ -37364,7 +37378,7 @@ Error details:
       }
       if (this.exitOnCtrlC && str === "\x03") {
         process.nextTick(() => {
-          process.exit(0);
+          process.exit();
         });
         return;
       }
@@ -37375,6 +37389,8 @@ Error details:
     });
     if (this._useAlternateScreen) {
       this.writeOut(ANSI.switchToAlternateScreen);
+    } else {
+      this.writeOut(ANSI.makeRoomForRenderer(this.height - 1));
     }
     this.setCursorPosition(0, 0, false);
   }
@@ -37496,7 +37512,7 @@ Error details:
     }
   }
   handleResize(width, height) {
-    if (this.isShuttingDown)
+    if (this.isDestroyed)
       return;
     if (this._splitHeight > 0) {
       this.processResize(width, height);
@@ -37633,44 +37649,31 @@ Error details:
     this._isRunning = false;
   }
   stop() {
-    if (this.isShuttingDown)
+    if (this.isRunning && !this.isDestroyed) {
+      this._isRunning = false;
+      if (this.memorySnapshotTimer) {
+        clearInterval(this.memorySnapshotTimer);
+        this.memorySnapshotTimer = null;
+      }
+      if (this.renderTimeout) {
+        clearTimeout(this.renderTimeout);
+        this.renderTimeout = null;
+      }
+    }
+  }
+  destroy() {
+    if (this.isDestroyed)
       return;
-    this._isRunning = false;
-    this.isShuttingDown = true;
+    this.isDestroyed = true;
     this.waitingForPixelResolution = false;
+    this.capturedRenderable = undefined;
     if (this.sigwinchHandler) {
       process.removeListener("SIGWINCH", this.sigwinchHandler);
       this.sigwinchHandler = null;
     }
     this._console.deactivate();
+    this.lib.destroyRenderer(this.rendererPtr, this._useAlternateScreen, this._splitHeight);
     this.disableStdoutInterception();
-    if (this.renderTimeout) {
-      clearTimeout(this.renderTimeout);
-      this.renderTimeout = null;
-    }
-    if (this.memorySnapshotTimer) {
-      clearInterval(this.memorySnapshotTimer);
-      this.memorySnapshotTimer = null;
-    }
-    if (this._splitHeight > 0) {
-      const consoleEndLine = this._terminalHeight - this._splitHeight;
-      this.writeOut(ANSI.moveCursor(consoleEndLine, 1));
-    }
-    this.capturedRenderable = undefined;
-    if (this._useMouse) {
-      this.disableMouse();
-    }
-    this.writeOut(ANSI.resetCursorColor);
-    this.writeOut(ANSI.showCursor);
-    if (this._useAlternateScreen) {
-      this.writeOut(ANSI.switchToMainScreen);
-    }
-  }
-  destroy() {
-    if (this.isDestroyed)
-      return;
-    this.lib.destroyRenderer(this.rendererPtr);
-    this.isDestroyed = true;
   }
   startRenderLoop() {
     if (!this._isRunning)
@@ -37683,7 +37686,7 @@ Error details:
     this.loop();
   }
   async loop() {
-    if (this.rendering)
+    if (this.rendering || this.isDestroyed)
       return;
     this.rendering = true;
     if (this.renderTimeout) {
@@ -37989,8 +37992,8 @@ class TextRenderable extends Renderable {
     const changed = this.selectionHelper.reevaluateSelection(this.width, this.height);
     if (changed) {
       this.syncSelectionToTextBuffer();
-      this.needsUpdate();
     }
+    this.needsUpdate();
   }
   setupMeasureFunc() {
     if (this._positionType === "relative" && this._width === "auto") {

package/README.md

@@ -3,6 +3,8 @@
 OpenTUI Core is a TypeScript library for building terminal user interfaces (TUIs). It is currently in
 development and is not ready for production use.
 
+[Getting Started](docs/getting-started.md)
+
 ## Install
 
 ```bash

package/ansi.d.ts

@@ -23,4 +23,6 @@ export declare const ANSI: {
     disableAnyEventTracking: string;
     enableSGRMouseMode: string;
     disableSGRMouseMode: string;
+    makeRoomForRenderer: (height: number) => string;
+    clearRendererSpace: (height: number) => string;
 };

package/index.js

@@ -3160,7 +3160,7 @@ function getOpenTUILib(libPath) {
       returns: "ptr"
     },
     destroyRenderer: {
-      args: ["ptr"],
+      args: ["ptr", "bool", "u32"],
       returns: "void"
     },
     setUseThread: {
@@ -3315,6 +3315,14 @@ function getOpenTUILib(libPath) {
       args: ["ptr", "i64"],
       returns: "void"
     },
+    enableMouse: {
+      args: ["ptr", "bool"],
+      returns: "void"
+    },
+    disableMouse: {
+      args: ["ptr"],
+      returns: "void"
+    },
     createTextBuffer: {
       args: ["u32"],
       returns: "ptr"
@@ -3423,8 +3431,8 @@ class FFIRenderLib {
   createRenderer(width, height) {
     return this.opentui.symbols.createRenderer(width, height);
   }
-  destroyRenderer(renderer) {
-    this.opentui.symbols.destroyRenderer(renderer);
+  destroyRenderer(renderer, useAlternateScreen, splitHeight) {
+    this.opentui.symbols.destroyRenderer(renderer, useAlternateScreen, splitHeight);
   }
   setUseThread(renderer, useThread) {
     this.opentui.symbols.setUseThread(renderer, useThread);
@@ -3634,6 +3642,12 @@ class FFIRenderLib {
     const ts = timestamp ?? Date.now();
     this.opentui.symbols.dumpStdoutBuffer(renderer, ts);
   }
+  enableMouse(renderer, enableMovement) {
+    this.opentui.symbols.enableMouse(renderer, enableMovement);
+  }
+  disableMouse(renderer) {
+    this.opentui.symbols.disableMouse(renderer);
+  }
   createTextBuffer(capacity) {
     const bufferPtr = this.opentui.symbols.createTextBuffer(capacity);
     if (!bufferPtr) {
@@ -7442,7 +7456,10 @@ var ANSI = {
   enableAnyEventTracking: "\x1B[?1003h",
   disableAnyEventTracking: "\x1B[?1003l",
   enableSGRMouseMode: "\x1B[?1006h",
-  disableSGRMouseMode: "\x1B[?1006l"
+  disableSGRMouseMode: "\x1B[?1006l",
+  makeRoomForRenderer: (height) => `
+`.repeat(height) + `\x1B[${height}A`,
+  clearRendererSpace: (height) => `\x1B[${height}A\x1B[1G\x1B[J`
 };
 
 // src/console.ts
@@ -8240,6 +8257,11 @@ var MouseButton;
   MouseButton2[MouseButton2["WHEEL_UP"] = 4] = "WHEEL_UP";
   MouseButton2[MouseButton2["WHEEL_DOWN"] = 5] = "WHEEL_DOWN";
 })(MouseButton ||= {});
+["SIGINT", "SIGTERM", "SIGQUIT", "SIGABRT"].forEach((signal) => {
+  process.on(signal, () => {
+    process.exit();
+  });
+});
 async function createCliRenderer(config = {}) {
   if (process.argv.includes("--delay-start")) {
     await new Promise((resolve) => setTimeout(resolve, 5000));
@@ -8276,7 +8298,6 @@ class CliRenderer extends EventEmitter6 {
   stdout;
   exitOnCtrlC;
   isDestroyed = false;
-  isShuttingDown = false;
   nextRenderBuffer;
   currentRenderBuffer;
   _isRunning = false;
@@ -8298,6 +8319,7 @@ class CliRenderer extends EventEmitter6 {
   postProcessFns = [];
   backgroundColor = RGBA.fromHex("#000000");
   waitingForPixelResolution = false;
+  shutdownRequested = null;
   rendering = false;
   renderingNative = false;
   renderTimeout = null;
@@ -8401,8 +8423,6 @@ class CliRenderer extends EventEmitter6 {
     }
     this.stdout.write = this.interceptStdoutWrite.bind(this);
     this.sigwinchHandler = () => {
-      if (this.isShuttingDown)
-        return;
       const width2 = this.stdout.columns || 80;
       const height2 = this.stdout.rows || 24;
       this.handleResize(width2, height2);
@@ -8410,6 +8430,7 @@ class CliRenderer extends EventEmitter6 {
     process.on("SIGWINCH", this.sigwinchHandler);
     const handleError = (error) => {
       this.stop();
+      this.destroy();
       new Promise((resolve) => {
         setTimeout(() => {
           resolve(true);
@@ -8443,8 +8464,7 @@ Error details:
     };
     process.on("uncaughtException", handleError);
     process.on("unhandledRejection", handleError);
-    process.on("exit", (code) => {
-      this.stop();
+    process.on("exit", () => {
       this.destroy();
     });
     this._console = new TerminalConsole(this, config.consoleOptions);
@@ -8463,6 +8483,13 @@ Error details:
     }
     global.window.requestAnimationFrame = requestAnimationFrame;
     this.queryPixelResolution();
+    if (process.env.OTUI_NO_NATIVE_RENDER === "true") {
+      this.renderNative = () => {
+        if (this._splitHeight > 0) {
+          this.flushStdoutCache(this._splitHeight);
+        }
+      };
+    }
   }
   writeOut(chunk, encoding, callback) {
     return this.realStdoutWrite.call(this.stdout, chunk, encoding, callback);
@@ -8594,30 +8621,17 @@ Error details:
     return true;
   }
   enableMouse() {
-    this.writeOut(ANSI.enableSGRMouseMode);
-    this.writeOut(ANSI.enableMouseTracking);
-    this.writeOut(ANSI.enableButtonEventTracking);
-    if (this.enableMouseMovement) {
-      this.writeOut(ANSI.enableAnyEventTracking);
-    }
+    this.lib.enableMouse(this.rendererPtr, this.enableMouseMovement);
   }
   disableMouse() {
-    if (this.enableMouseMovement) {
-      this.writeOut(ANSI.disableAnyEventTracking);
-    }
-    this.writeOut(ANSI.disableButtonEventTracking);
-    this.writeOut(ANSI.disableMouseTracking);
-    this.writeOut(ANSI.disableSGRMouseMode);
     this.capturedRenderable = undefined;
     this.mouseParser.reset();
+    this.lib.disableMouse(this.rendererPtr);
   }
   set useThread(useThread) {
     this._useThread = useThread;
     this.lib.setUseThread(this.rendererPtr, useThread);
   }
-  setTerminalSize(width, height) {
-    this.handleResize(width, height);
-  }
   setupTerminal() {
     this.writeOut(ANSI.saveCursorState);
     if (this.stdin.setRawMode) {
@@ -8644,7 +8658,7 @@ Error details:
       }
       if (this.exitOnCtrlC && str === "\x03") {
         process.nextTick(() => {
-          process.exit(0);
+          process.exit();
         });
         return;
       }
@@ -8655,6 +8669,8 @@ Error details:
     });
     if (this._useAlternateScreen) {
       this.writeOut(ANSI.switchToAlternateScreen);
+    } else {
+      this.writeOut(ANSI.makeRoomForRenderer(this.height - 1));
     }
     this.setCursorPosition(0, 0, false);
   }
@@ -8776,7 +8792,7 @@ Error details:
     }
   }
   handleResize(width, height) {
-    if (this.isShuttingDown)
+    if (this.isDestroyed)
       return;
     if (this._splitHeight > 0) {
       this.processResize(width, height);
@@ -8913,44 +8929,31 @@ Error details:
     this._isRunning = false;
   }
   stop() {
-    if (this.isShuttingDown)
+    if (this.isRunning && !this.isDestroyed) {
+      this._isRunning = false;
+      if (this.memorySnapshotTimer) {
+        clearInterval(this.memorySnapshotTimer);
+        this.memorySnapshotTimer = null;
+      }
+      if (this.renderTimeout) {
+        clearTimeout(this.renderTimeout);
+        this.renderTimeout = null;
+      }
+    }
+  }
+  destroy() {
+    if (this.isDestroyed)
       return;
-    this._isRunning = false;
-    this.isShuttingDown = true;
+    this.isDestroyed = true;
     this.waitingForPixelResolution = false;
+    this.capturedRenderable = undefined;
     if (this.sigwinchHandler) {
       process.removeListener("SIGWINCH", this.sigwinchHandler);
       this.sigwinchHandler = null;
     }
     this._console.deactivate();
+    this.lib.destroyRenderer(this.rendererPtr, this._useAlternateScreen, this._splitHeight);
     this.disableStdoutInterception();
-    if (this.renderTimeout) {
-      clearTimeout(this.renderTimeout);
-      this.renderTimeout = null;
-    }
-    if (this.memorySnapshotTimer) {
-      clearInterval(this.memorySnapshotTimer);
-      this.memorySnapshotTimer = null;
-    }
-    if (this._splitHeight > 0) {
-      const consoleEndLine = this._terminalHeight - this._splitHeight;
-      this.writeOut(ANSI.moveCursor(consoleEndLine, 1));
-    }
-    this.capturedRenderable = undefined;
-    if (this._useMouse) {
-      this.disableMouse();
-    }
-    this.writeOut(ANSI.resetCursorColor);
-    this.writeOut(ANSI.showCursor);
-    if (this._useAlternateScreen) {
-      this.writeOut(ANSI.switchToMainScreen);
-    }
-  }
-  destroy() {
-    if (this.isDestroyed)
-      return;
-    this.lib.destroyRenderer(this.rendererPtr);
-    this.isDestroyed = true;
   }
   startRenderLoop() {
     if (!this._isRunning)
@@ -8963,7 +8966,7 @@ Error details:
     this.loop();
   }
   async loop() {
-    if (this.rendering)
+    if (this.rendering || this.isDestroyed)
       return;
     this.rendering = true;
     if (this.renderTimeout) {
@@ -9429,8 +9432,8 @@ class TextRenderable extends Renderable {
     const changed = this.selectionHelper.reevaluateSelection(this.width, this.height);
     if (changed) {
       this.syncSelectionToTextBuffer();
-      this.needsUpdate();
     }
+    this.needsUpdate();
   }
   setupMeasureFunc() {
     if (this._positionType === "relative" && this._width === "auto") {

package/package.json

@@ -4,7 +4,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "type": "module",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "OpenTUI is a TypeScript library for building terminal user interfaces (TUIs)",
   "license": "MIT",
   "repository": {
@@ -39,11 +39,11 @@
     "bun-webgpu": "0.1.3",
     "planck": "^1.4.2",
     "three": "0.177.0",
-    "@opentui/core-darwin-x64": "0.1.6",
-    "@opentui/core-darwin-arm64": "0.1.6",
-    "@opentui/core-linux-x64": "0.1.6",
-    "@opentui/core-linux-arm64": "0.1.6",
-    "@opentui/core-win32-x64": "0.1.6",
-    "@opentui/core-win32-arm64": "0.1.6"
+    "@opentui/core-darwin-x64": "0.1.7",
+    "@opentui/core-darwin-arm64": "0.1.7",
+    "@opentui/core-linux-x64": "0.1.7",
+    "@opentui/core-linux-arm64": "0.1.7",
+    "@opentui/core-win32-x64": "0.1.7",
+    "@opentui/core-win32-arm64": "0.1.7"
   }
 }

package/renderer.d.ts

@@ -67,7 +67,6 @@ export declare class CliRenderer extends EventEmitter {
     private stdout;
     private exitOnCtrlC;
     private isDestroyed;
-    private isShuttingDown;
     nextRenderBuffer: OptimizedBuffer;
     currentRenderBuffer: OptimizedBuffer;
     private _isRunning;
@@ -85,6 +84,7 @@ export declare class CliRenderer extends EventEmitter {
     private postProcessFns;
     private backgroundColor;
     private waitingForPixelResolution;
+    private shutdownRequested;
     private rendering;
     private renderingNative;
     private renderTimeout;
@@ -146,7 +146,6 @@ export declare class CliRenderer extends EventEmitter {
     private enableMouse;
     private disableMouse;
     set useThread(useThread: boolean);
-    setTerminalSize(width: number, height: number): void;
     private setupTerminal;
     private handleMouseData;
     private takeMemorySnapshot;

package/zig.d.ts

@@ -5,7 +5,7 @@ import { OptimizedBuffer } from "./buffer";
 import { TextBuffer } from "./text-buffer";
 export interface RenderLib {
     createRenderer: (width: number, height: number) => Pointer | null;
-    destroyRenderer: (renderer: Pointer) => void;
+    destroyRenderer: (renderer: Pointer, useAlternateScreen: boolean, splitHeight: number) => void;
     setUseThread: (renderer: Pointer, useThread: boolean) => void;
     setBackgroundColor: (renderer: Pointer, color: RGBA) => void;
     setRenderOffset: (renderer: Pointer, offset: number) => void;
@@ -49,6 +49,8 @@ export interface RenderLib {
     dumpHitGrid: (renderer: Pointer) => void;
     dumpBuffers: (renderer: Pointer, timestamp?: number) => void;
     dumpStdoutBuffer: (renderer: Pointer, timestamp?: number) => void;
+    enableMouse: (renderer: Pointer, enableMovement: boolean) => void;
+    disableMouse: (renderer: Pointer) => void;
     createTextBuffer: (capacity: number) => TextBuffer;
     destroyTextBuffer: (buffer: Pointer) => void;
     textBufferGetCharPtr: (buffer: Pointer) => Pointer;