@opentui/core 0.0.0-20250922-cfcd1c78 → 0.0.0-20250924-d06b64fa

package/3d.js

@@ -5,7 +5,7 @@ import {
   __export,
   __require,
   __toESM
-} from "./index-eqy4135c.js";
+} from "./index-6kvgbzah.js";
 
 // ../../node_modules/omggif/omggif.js
 var require_omggif = __commonJS((exports) => {

package/animation/Timeline.d.ts

@@ -1,3 +1,4 @@
+import type { CliRenderer } from "../renderer";
 export interface TimelineOptions {
     duration?: number;
     loop?: boolean;
@@ -111,7 +112,7 @@ declare class TimelineEngine {
     defaults: {
         frameRate: number;
     };
-    attach(renderer: any): void;
+    attach(renderer: CliRenderer): void;
     detach(): void;
     private updateLiveState;
     private onTimelineStateChange;

package/ansi.d.ts

@@ -2,28 +2,12 @@ export declare const ANSI: {
     switchToAlternateScreen: string;
     switchToMainScreen: string;
     reset: string;
-    hideCursor: string;
-    showCursor: string;
-    resetCursorColor: string;
-    saveCursorState: string;
-    restoreCursorState: string;
-    queryPixelSize: string;
     scrollDown: (lines: number) => string;
     scrollUp: (lines: number) => string;
     moveCursor: (row: number, col: number) => string;
     moveCursorAndClear: (row: number, col: number) => string;
-    clearFromCursor: string;
     setRgbBackground: (r: number, g: number, b: number) => string;
     resetBackground: string;
-    enableMouseTracking: string;
-    disableMouseTracking: string;
-    enableButtonEventTracking: string;
-    disableButtonEventTracking: string;
-    enableAnyEventTracking: string;
-    disableAnyEventTracking: string;
-    enableSGRMouseMode: string;
-    disableSGRMouseMode: string;
-    clearRendererSpace: (height: number) => string;
     bracketedPasteStart: string;
     bracketedPasteEnd: string;
 };

package/{index-eqy4135c.js → index-6kvgbzah.js}

@@ -2180,28 +2180,12 @@ var ANSI = {
   switchToAlternateScreen: "\x1B[?1049h",
   switchToMainScreen: "\x1B[?1049l",
   reset: "\x1B[0m",
-  hideCursor: "\x1B[?25l",
-  showCursor: "\x1B[?25h",
-  resetCursorColor: "\x1B]12;default\x07",
-  saveCursorState: "\x1B[s",
-  restoreCursorState: "\x1B[u",
-  queryPixelSize: "\x1B[14t",
   scrollDown: (lines) => `\x1B[${lines}T`,
   scrollUp: (lines) => `\x1B[${lines}S`,
   moveCursor: (row, col) => `\x1B[${row};${col}H`,
   moveCursorAndClear: (row, col) => `\x1B[${row};${col}H\x1B[J`,
-  clearFromCursor: "\x1B[J",
   setRgbBackground: (r, g, b) => `\x1B[48;2;${r};${g};${b}m`,
   resetBackground: "\x1B[49m",
-  enableMouseTracking: "\x1B[?1000h",
-  disableMouseTracking: "\x1B[?1000l",
-  enableButtonEventTracking: "\x1B[?1002h",
-  disableButtonEventTracking: "\x1B[?1002l",
-  enableAnyEventTracking: "\x1B[?1003h",
-  disableAnyEventTracking: "\x1B[?1003l",
-  enableSGRMouseMode: "\x1B[?1006h",
-  disableSGRMouseMode: "\x1B[?1006l",
-  clearRendererSpace: (height) => `\x1B[${height}A\x1B[1G\x1B[J`,
   bracketedPasteStart: "\x1B[200~",
   bracketedPasteEnd: "\x1B[201~"
 };
@@ -2217,11 +2201,6 @@ class KeyHandler extends EventEmitter {
     super();
     this.stdin = stdin || process.stdin;
     this.useKittyKeyboard = useKittyKeyboard;
-    if (this.stdin.setRawMode) {
-      this.stdin.setRawMode(true);
-    }
-    this.stdin.resume();
-    this.stdin.setEncoding("utf8");
     this.listener = (key) => {
       let data = key.toString();
       if (data.startsWith(ANSI.bracketedPasteStart)) {
@@ -2256,9 +2235,6 @@ class KeyHandler extends EventEmitter {
   }
   destroy() {
     this.stdin.removeListener("data", this.listener);
-    if (this.stdin.setRawMode) {
-      this.stdin.setRawMode(false);
-    }
   }
 }
 
@@ -4838,6 +4814,166 @@ class ASCIIFontSelectionHelper {
     return previousSelection?.start !== this.localSelection?.start || previousSelection?.end !== this.localSelection?.end;
   }
 }
+
+// src/lib/singleton.ts
+var singletonCacheSymbol = Symbol.for("@opentui/core/singleton");
+function singleton(key, factory) {
+  const bag = globalThis[singletonCacheSymbol] ??= {};
+  if (!(key in bag)) {
+    bag[key] = factory();
+  }
+  return bag[key];
+}
+
+// src/lib/env.ts
+var envRegistry = {};
+function registerEnvVar(config) {
+  const existing = envRegistry[config.name];
+  if (existing) {
+    if (existing.description !== config.description || existing.type !== config.type || existing.default !== config.default) {
+      throw new Error(`Environment variable "${config.name}" is already registered with different configuration. ` + `Existing: ${JSON.stringify(existing)}, New: ${JSON.stringify(config)}`);
+    }
+    return;
+  }
+  envRegistry[config.name] = config;
+}
+function normalizeBoolean(value) {
+  const lowerValue = value.toLowerCase();
+  return ["true", "1", "on", "yes"].includes(lowerValue);
+}
+function parseEnvValue(config) {
+  const envValue = process.env[config.name];
+  if (envValue === undefined && config.default !== undefined) {
+    return config.default;
+  }
+  if (envValue === undefined) {
+    throw new Error(`Required environment variable ${config.name} is not set. ${config.description}`);
+  }
+  switch (config.type) {
+    case "boolean":
+      return typeof envValue === "boolean" ? envValue : normalizeBoolean(envValue);
+    case "number":
+      const numValue = Number(envValue);
+      if (isNaN(numValue)) {
+        throw new Error(`Environment variable ${config.name} must be a valid number, got: ${envValue}`);
+      }
+      return numValue;
+    case "string":
+    default:
+      return envValue;
+  }
+}
+
+class EnvStore {
+  parsedValues = new Map;
+  get(key) {
+    if (this.parsedValues.has(key)) {
+      return this.parsedValues.get(key);
+    }
+    if (!(key in envRegistry)) {
+      throw new Error(`Environment variable ${key} is not registered.`);
+    }
+    try {
+      const value = parseEnvValue(envRegistry[key]);
+      this.parsedValues.set(key, value);
+      return value;
+    } catch (error) {
+      throw new Error(`Failed to parse env var ${key}: ${error instanceof Error ? error.message : String(error)}`);
+    }
+  }
+  has(key) {
+    return key in envRegistry;
+  }
+}
+var envStore = singleton("env-store", () => new EnvStore);
+function generateEnvMarkdown() {
+  const configs = Object.values(envRegistry);
+  if (configs.length === 0) {
+    return `# Environment Variables
+
+No environment variables registered.
+`;
+  }
+  let markdown = `# Environment Variables
+
+`;
+  for (const config of configs) {
+    markdown += `## ${config.name}
+
+`;
+    markdown += `${config.description}
+
+`;
+    markdown += `**Type:** \`${config.type || "string"}\`  
+`;
+    if (config.default !== undefined) {
+      const defaultValue = typeof config.default === "string" ? `"${config.default}"` : String(config.default);
+      markdown += `**Default:** \`${defaultValue}\`  
+`;
+    } else {
+      markdown += `**Default:** *Required*  
+`;
+    }
+    markdown += `
+`;
+  }
+  return markdown;
+}
+function generateEnvColored() {
+  const configs = Object.values(envRegistry);
+  if (configs.length === 0) {
+    return `\x1B[1;36mEnvironment Variables\x1B[0m
+
+No environment variables registered.
+`;
+  }
+  let output = `\x1B[1;36mEnvironment Variables\x1B[0m
+
+`;
+  for (const config of configs) {
+    output += `\x1B[1;33m${config.name}\x1B[0m
+`;
+    output += `${config.description}
+`;
+    output += `\x1B[32mType:\x1B[0m \x1B[36m${config.type || "string"}\x1B[0m
+`;
+    if (config.default !== undefined) {
+      const defaultValue = typeof config.default === "string" ? `"${config.default}"` : String(config.default);
+      output += `\x1B[32mDefault:\x1B[0m \x1B[35m${defaultValue}\x1B[0m
+`;
+    } else {
+      output += `\x1B[32mDefault:\x1B[0m \x1B[31mRequired\x1B[0m
+`;
+    }
+    output += `
+`;
+  }
+  return output;
+}
+var env = new Proxy({}, {
+  get(target, prop) {
+    if (typeof prop !== "string") {
+      return;
+    }
+    return envStore.get(prop);
+  },
+  has(target, prop) {
+    return envStore.has(prop);
+  },
+  ownKeys() {
+    return Object.keys(envRegistry);
+  },
+  getOwnPropertyDescriptor(target, prop) {
+    if (envStore.has(prop)) {
+      return {
+        enumerable: true,
+        configurable: true,
+        get: () => envStore.get(prop)
+      };
+    }
+    return;
+  }
+});
 // src/zig.ts
 import { dlopen, toArrayBuffer as toArrayBuffer2, JSCallback, ptr } from "bun:ffi";
 import { existsSync } from "fs";
@@ -5044,6 +5180,18 @@ var targetLibPath = module.default;
 if (!existsSync(targetLibPath)) {
   throw new Error(`opentui is not supported on the current platform: ${process.platform}-${process.arch}`);
 }
+registerEnvVar({
+  name: "OTUI_DEBUG_FFI",
+  description: "Enable debug logging for the FFI bindings.",
+  type: "boolean",
+  default: false
+});
+registerEnvVar({
+  name: "OTUI_TRACE_FFI",
+  description: "Enable tracing for the FFI bindings.",
+  type: "boolean",
+  default: false
+});
 function getOpenTUILib(libPath) {
   const resolvedLibPath = libPath || targetLibPath;
   const rawSymbols = dlopen(resolvedLibPath, {
@@ -5091,6 +5239,10 @@ function getOpenTUILib(libPath) {
       args: ["ptr"],
       returns: "ptr"
     },
+    queryPixelResolution: {
+      args: ["ptr"],
+      returns: "void"
+    },
     createOptimizedBuffer: {
       args: ["u32", "u32", "bool", "u8", "ptr", "usize"],
       returns: "ptr"
@@ -5380,7 +5532,7 @@ function getOpenTUILib(libPath) {
       returns: "void"
     }
   });
-  if (process.env.DEBUG_FFI === "true" || process.env.TRACE_FFI === "true") {
+  if (env.OTUI_DEBUG_FFI || env.OTUI_TRACE_FFI) {
     return {
       symbols: convertToDebugSymbols(rawSymbols.symbols)
     };
@@ -5394,7 +5546,7 @@ function convertToDebugSymbols(symbols) {
   Object.entries(symbols).forEach(([key, value]) => {
     debugSymbols[key] = value;
   });
-  if (process.env.DEBUG_FFI === "true") {
+  if (env.OTUI_DEBUG_FFI) {
     Object.entries(symbols).forEach(([key, value]) => {
       if (typeof value === "function") {
         debugSymbols[key] = (...args) => {
@@ -5406,7 +5558,7 @@ function convertToDebugSymbols(symbols) {
       }
     });
   }
-  if (process.env.TRACE_FFI === "true") {
+  if (env.OTUI_TRACE_FFI) {
     hasTracing = true;
     Object.entries(symbols).forEach(([key, value]) => {
       if (typeof value === "function") {
@@ -5768,6 +5920,9 @@ class FFIRenderLib {
   setupTerminal(renderer, useAlternateScreen) {
     this.opentui.symbols.setupTerminal(renderer, useAlternateScreen);
   }
+  queryPixelResolution(renderer) {
+    this.opentui.symbols.queryPixelResolution(renderer);
+  }
   createTextBuffer(widthMethod) {
     const widthMethodCode = widthMethod === "wcwidth" ? 0 : 1;
     const bufferPtr = this.opentui.symbols.createTextBuffer(widthMethodCode);
@@ -7564,16 +7719,6 @@ class CapturedWritableStream extends Writable {
   }
 }
 
-// src/singleton.ts
-var singletonCacheSymbol = Symbol.for("@opentui/core/singleton");
-function singleton(key, factory) {
-  const bag = globalThis[singletonCacheSymbol] ??= {};
-  if (!(key in bag)) {
-    bag[key] = factory();
-  }
-  return bag[key];
-}
-
 // src/console.ts
 function getCallerInfo() {
   const err = new Error;
@@ -7594,6 +7739,18 @@ function getCallerInfo() {
   return { functionName, fullPath, fileName, lineNumber, columnNumber };
 }
 var capture = singleton("ConsoleCapture", () => new Capture);
+registerEnvVar({
+  name: "OTUI_USE_CONSOLE",
+  description: "Whether to use the console. Will not capture console output if set to false.",
+  type: "boolean",
+  default: true
+});
+registerEnvVar({
+  name: "SHOW_CONSOLE",
+  description: "Show the console at startup if set to true.",
+  type: "boolean",
+  default: false
+});
 
 class TerminalConsoleCache extends EventEmitter4 {
   _cachedLogs = [];
@@ -7611,7 +7768,7 @@ class TerminalConsoleCache extends EventEmitter4 {
     this.overrideConsoleMethods();
   }
   setupConsoleCapture() {
-    if (process.env.OTUI_USE_CONSOLE === "false")
+    if (!env.OTUI_USE_CONSOLE)
       return;
     const mockStdout = new CapturedWritableStream("stdout", capture);
     const mockStderr = new CapturedWritableStream("stderr", capture);
@@ -7776,7 +7933,7 @@ class TerminalConsole extends EventEmitter4 {
     terminalConsoleCache.on("entry", (logEntry) => {
       this._handleNewLog(logEntry);
     });
-    if (process.env.SHOW_CONSOLE === "true") {
+    if (env.SHOW_CONSOLE) {
       this.show();
     }
   }
@@ -8254,6 +8411,19 @@ function getObjectsInViewport(viewport, objects, direction = "column", padding =
 }
 
 // src/renderer.ts
+registerEnvVar({
+  name: "OTUI_DUMP_CAPTURES",
+  description: "Dump captured output when the renderer exits.",
+  type: "boolean",
+  default: false
+});
+registerEnvVar({
+  name: "OTUI_NO_NATIVE_RENDER",
+  description: "Disable native rendering. This will not actually output ansi and is useful for debugging.",
+  type: "boolean",
+  default: false
+});
+
 class MouseEvent {
   type;
   button;
@@ -8481,14 +8651,14 @@ Captured output:
       this.realStdoutWrite.call(this.stdout, capturedOutput + `
 `);
     }
+    this.realStdoutWrite.call(this.stdout, ANSI.reset);
   }
   exitHandler = (() => {
-    if (true) {
-      this.dumpOutputCache(`
-=== UNHANDLED OUTPUT (this is only printed in non-production environments) ===
+    this.destroy();
+    if (env.OTUI_DUMP_CAPTURES) {
+      this.dumpOutputCache(`=== CAPTURED OUTPUT ===
 `);
     }
-    this.destroy();
   }).bind(this);
   warningHandler = ((warning) => {
     console.warn(JSON.stringify(warning.message, null, 2));
@@ -8552,7 +8722,7 @@ Captured output:
       global.window = {};
     }
     global.window.requestAnimationFrame = requestAnimationFrame;
-    if (process.env.OTUI_NO_NATIVE_RENDER === "true") {
+    if (env.OTUI_NO_NATIVE_RENDER) {
       this.renderNative = () => {
         if (this._splitHeight > 0) {
           this.flushStdoutCache(this._splitHeight);
@@ -8755,11 +8925,6 @@ Captured output:
     if (this._terminalIsSetup)
       return;
     this._terminalIsSetup = true;
-    if (this.stdin.setRawMode) {
-      this.stdin.setRawMode(true);
-    }
-    this.stdin.resume();
-    this.stdin.setEncoding("utf8");
     await new Promise((resolve) => {
       const timeout = setTimeout(() => {
         this.stdin.off("data", capListener);
@@ -8806,6 +8971,11 @@ Captured output:
     this.emit("key", data);
   }).bind(this);
   setupInput() {
+    if (this.stdin.setRawMode) {
+      this.stdin.setRawMode(true);
+    }
+    this.stdin.resume();
+    this.stdin.setEncoding("utf8");
     this.stdin.on("data", this.stdinListener);
   }
   handleMouseData(data) {
@@ -8971,7 +9141,7 @@ Captured output:
   }
   queryPixelResolution() {
     this.waitingForPixelResolution = true;
-    this.writeOut(ANSI.queryPixelSize);
+    this.lib.queryPixelResolution(this.rendererPtr);
   }
   processResize(width, height) {
     if (width === this._terminalWidth && height === this._terminalHeight)
@@ -9034,9 +9204,6 @@ Captured output:
     this.lib.setDebugOverlay(this.rendererPtr, this.debugOverlay.enabled, this.debugOverlay.corner);
     this.requestRender();
   }
-  clearTerminal() {
-    this.lib.clearTerminal(this.rendererPtr);
-  }
   setTerminalTitle(title) {
     this.lib.setTerminalTitle(this.rendererPtr, title);
   }
@@ -9149,7 +9316,6 @@ Captured output:
     }
   }
   destroy() {
-    this.stdin.removeListener("data", this.stdinListener);
     process.removeListener("SIGWINCH", this.sigwinchHandler);
     process.removeListener("uncaughtException", this.handleError);
     process.removeListener("unhandledRejection", this.handleError);
@@ -9158,12 +9324,14 @@ Captured output:
     if (this.memorySnapshotTimer) {
       clearInterval(this.memorySnapshotTimer);
     }
-    if (this.stdin.setRawMode) {
-      this.stdin.setRawMode(false);
-    }
     if (this.isDestroyed)
       return;
     this.isDestroyed = true;
+    if (this.renderTimeout) {
+      clearTimeout(this.renderTimeout);
+      this.renderTimeout = null;
+    }
+    this._isRunning = false;
     this.waitingForPixelResolution = false;
     this.capturedRenderable = undefined;
     this.root.destroyRecursively();
@@ -9173,6 +9341,10 @@ Captured output:
     if (this._splitHeight > 0) {
       this.flushStdoutCache(this._splitHeight, true);
     }
+    if (this.stdin.setRawMode) {
+      this.stdin.setRawMode(false);
+    }
+    this.stdin.removeListener("data", this.stdinListener);
     this.lib.destroyRenderer(this.rendererPtr);
     rendererTracker.removeRenderer(this);
   }
@@ -9231,7 +9403,9 @@ Captured output:
       postProcessFn(this.nextRenderBuffer, deltaTime);
     }
     this._console.renderToBuffer(this.nextRenderBuffer);
-    this.renderNative();
+    if (!this.isDestroyed) {
+      this.renderNative();
+    }
     const overallFrameTime = performance.now() - overallStart;
     this.lib.updateStats(this.rendererPtr, overallFrameTime, this.renderStats.fps, this.renderStats.frameCallbackTime);
     if (this.gatherStats) {
@@ -9398,7 +9572,7 @@ Captured output:
   }
 }
 
-export { __toESM, __commonJS, __export, __require, Edge, Gutter, exports_src, BorderChars, getBorderFromSides, getBorderSides, borderCharsToArray, BorderCharArrays, nonAlphanumericKeys, parseKeypress, ANSI, KeyHandler, RGBA, hexToRgb, rgbToHex, hsvToRgb, parseColor, fonts, measureText, getCharacterPositions, coordinateToCharacterIndex, renderFontToFrameBuffer, TextAttributes, DebugOverlayCorner, createTextAttributes, visualizeRenderableTree, isStyledText, StyledText, stringToStyledText, black, red, green, yellow, blue, magenta, cyan, white, brightBlack, brightRed, brightGreen, brightYellow, brightBlue, brightMagenta, brightCyan, brightWhite, bgBlack, bgRed, bgGreen, bgYellow, bgBlue, bgMagenta, bgCyan, bgWhite, bold, italic, underline, strikethrough, dim, reverse, blink, fg, bg, t, SyntaxStyle, hastToStyledText, parseAlign, parseBoxSizing, parseDimension, parseDirection, parseDisplay, parseEdge, parseFlexDirection, parseGutter, parseJustify, parseLogLevel, parseMeasureMode, parseOverflow, parsePositionType, parseUnit, parseWrap, MouseParser, Selection, convertGlobalToLocalSelection, ASCIIFontSelectionHelper, TextBuffer, LogLevel2 as LogLevel, setRenderLibPath, resolveRenderLib, OptimizedBuffer, h, isVNode, maybeMakeRenderable, wrapWithDelegates, instantiate, delegate, isValidPercentage, LayoutEvents, RenderableEvents, isRenderable, BaseRenderable, Renderable, RootRenderable, capture, ConsolePosition, TerminalConsole, getObjectsInViewport, MouseEvent, MouseButton, createCliRenderer, CliRenderEvents, CliRenderer };
+export { __toESM, __commonJS, __export, __require, Edge, Gutter, exports_src, BorderChars, getBorderFromSides, getBorderSides, borderCharsToArray, BorderCharArrays, nonAlphanumericKeys, parseKeypress, ANSI, KeyHandler, RGBA, hexToRgb, rgbToHex, hsvToRgb, parseColor, fonts, measureText, getCharacterPositions, coordinateToCharacterIndex, renderFontToFrameBuffer, TextAttributes, DebugOverlayCorner, createTextAttributes, visualizeRenderableTree, isStyledText, StyledText, stringToStyledText, black, red, green, yellow, blue, magenta, cyan, white, brightBlack, brightRed, brightGreen, brightYellow, brightBlue, brightMagenta, brightCyan, brightWhite, bgBlack, bgRed, bgGreen, bgYellow, bgBlue, bgMagenta, bgCyan, bgWhite, bold, italic, underline, strikethrough, dim, reverse, blink, fg, bg, t, SyntaxStyle, hastToStyledText, parseAlign, parseBoxSizing, parseDimension, parseDirection, parseDisplay, parseEdge, parseFlexDirection, parseGutter, parseJustify, parseLogLevel, parseMeasureMode, parseOverflow, parsePositionType, parseUnit, parseWrap, MouseParser, Selection, convertGlobalToLocalSelection, ASCIIFontSelectionHelper, envRegistry, registerEnvVar, generateEnvMarkdown, generateEnvColored, env, TextBuffer, LogLevel2 as LogLevel, setRenderLibPath, resolveRenderLib, OptimizedBuffer, h, isVNode, maybeMakeRenderable, wrapWithDelegates, instantiate, delegate, isValidPercentage, LayoutEvents, RenderableEvents, isRenderable, BaseRenderable, Renderable, RootRenderable, capture, ConsolePosition, TerminalConsole, getObjectsInViewport, MouseEvent, MouseButton, createCliRenderer, CliRenderEvents, CliRenderer };
 
-//# debugId=C47A8261B5915FF064756E2164756E21
-//# sourceMappingURL=index-eqy4135c.js.map
+//# debugId=FA47EE78BCA83E8664756E2164756E21
+//# sourceMappingURL=index-6kvgbzah.js.map