@oh-my-pi/pi-tui 9.0.0 → 9.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@oh-my-pi/pi-tui",
-	"version": "9.0.0",
+	"version": "9.1.0",
 	"description": "Terminal User Interface library with differential rendering for efficient text-based applications",
 	"type": "module",
 	"main": "./src/index.ts",
@@ -47,7 +47,7 @@
 		"bun": ">=1.3.7"
 	},
 	"dependencies": {
-		"@oh-my-pi/pi-natives": "9.0.0",
+		"@oh-my-pi/pi-natives": "9.1.0",
 		"@types/mime-types": "^3.0.1",
 		"chalk": "^5.6.2",
 		"marked": "^17.0.1",

package/src/components/image.ts

@@ -1,10 +1,4 @@
-import {
-	getCapabilities,
-	getImageDimensions,
-	type ImageDimensions,
-	imageFallback,
-	renderImage,
-} from "../terminal-image";
+import { getImageDimensions, type ImageDimensions, imageFallback, renderImage, TERMINAL_INFO } from "../terminal-image";
 import type { Component } from "../tui";
 
 export interface ImageTheme {
@@ -53,10 +47,9 @@ export class Image implements Component {
 
 		const maxWidth = Math.min(width - 2, this.options.maxWidthCells ?? 60);
 
-		const caps = getCapabilities();
 		let lines: string[];
 
-		if (caps.images) {
+		if (TERMINAL_INFO.imageProtocol) {
 			const result = renderImage(this.base64Data, this.dimensions, { maxWidthCells: maxWidth });
 
 			if (result) {

package/src/components/markdown.ts

@@ -1,7 +1,7 @@
 import { marked, type Token } from "marked";
 import type { MermaidImage } from "../mermaid";
 import type { SymbolTheme } from "../symbols";
-import { encodeITerm2, encodeKitty, getCapabilities, getCellDimensions } from "../terminal-image";
+import { encodeITerm2, encodeKitty, getCellDimensions, ImageProtocol, TERMINAL_INFO } from "../terminal-image";
 import type { Component } from "../tui";
 import { applyBackgroundToLine, visibleWidth, wrapTextWithAnsi } from "../utils";
 
@@ -290,9 +290,8 @@ export class Markdown implements Component {
 				if (token.lang === "mermaid" && this.theme.getMermaidImage) {
 					const hash = Bun.hash(token.text.trim()).toString(16);
 					const image = this.theme.getMermaidImage(hash);
-					const caps = getCapabilities();
 
-					if (image && caps.images) {
+					if (image && TERMINAL_INFO.imageProtocol) {
 						const imageLines = this.renderMermaidImage(image, width);
 						if (imageLines) {
 							lines.push(...imageLines);
@@ -771,8 +770,7 @@ export class Markdown implements Component {
 	 * Returns array of lines (image placeholder rows) or null if rendering fails.
 	 */
 	private renderMermaidImage(image: MermaidImage, availableWidth: number): string[] | null {
-		const caps = getCapabilities();
-		if (!caps.images) return null;
+		if (!TERMINAL_INFO.imageProtocol) return null;
 
 		const cellDims = getCellDimensions();
 		const scale = 0.5; // Render at 50% of natural size
@@ -796,16 +794,19 @@ export class Markdown implements Component {
 		}
 
 		let sequence: string;
-		if (caps.images === "kitty") {
-			sequence = encodeKitty(image.base64, { columns, rows });
-		} else if (caps.images === "iterm2") {
-			sequence = encodeITerm2(image.base64, {
-				width: columns,
-				height: "auto",
-				preserveAspectRatio: true,
-			});
-		} else {
-			return null;
+		switch (TERMINAL_INFO.imageProtocol) {
+			case ImageProtocol.Kitty:
+				sequence = encodeKitty(image.base64, { columns, rows });
+				break;
+			case ImageProtocol.Iterm2:
+				sequence = encodeITerm2(image.base64, {
+					width: columns,
+					height: "auto",
+					preserveAspectRatio: true,
+				});
+				break;
+			default:
+				return null;
 		}
 
 		// Reserve space with empty lines, then output image with cursor-up

package/src/index.ts

@@ -64,24 +64,24 @@ export { emergencyTerminalRestore, ProcessTerminal, type Terminal } from "./term
 export {
 	type CellDimensions,
 	calculateImageRows,
-	detectCapabilities,
 	encodeITerm2,
 	encodeKitty,
-	getCapabilities,
 	getCellDimensions,
 	getGifDimensions,
 	getImageDimensions,
 	getJpegDimensions,
 	getPngDimensions,
+	getTerminalInfo,
 	getWebpDimensions,
 	type ImageDimensions,
-	type ImageProtocol,
 	type ImageRenderOptions,
 	imageFallback,
 	renderImage,
-	resetCapabilitiesCache,
 	setCellDimensions,
-	type TerminalCapabilities,
+	TERMINAL_ID,
+	TERMINAL_INFO,
+	type TerminalId,
+	type TerminalInfo,
 } from "./terminal-image";
 export { type Component, Container, type OverlayHandle, type SizeValue, TUI } from "./tui";
 // Utilities

package/src/terminal-image.ts

@@ -1,10 +1,81 @@
-export type ImageProtocol = "kitty" | "iterm2" | null;
+export enum ImageProtocol {
+	Kitty = "\x1b_G",
+	Iterm2 = "\x1b]1337;File=",
+}
+
+export type TerminalId = "kitty" | "ghostty" | "wezterm" | "iterm2" | "vscode" | "alacritty" | "base" | "trueColor";
+
+export class TerminalInfo {
+	constructor(
+		public readonly id: TerminalId,
+		public readonly imageProtocol: ImageProtocol | null,
+		public readonly trueColor: boolean,
+		public readonly hyperlinks: boolean,
+	) {}
+
+	isImageLine(line: string): boolean {
+		return !!this.imageProtocol && line.trimStart().startsWith(this.imageProtocol);
+	}
+}
+
+const KNOWN_TERMINALS = Object.freeze({
+	// Fallback terminals
+	base: new TerminalInfo("base", null, false, true),
+	trueColor: new TerminalInfo("trueColor", null, true, true),
+	// Recognized terminals
+	kitty: new TerminalInfo("kitty", ImageProtocol.Kitty, true, true),
+	ghostty: new TerminalInfo("ghostty", ImageProtocol.Kitty, true, true),
+	wezterm: new TerminalInfo("wezterm", ImageProtocol.Kitty, true, true),
+	iterm2: new TerminalInfo("iterm2", ImageProtocol.Iterm2, true, true),
+	vscode: new TerminalInfo("vscode", null, true, true),
+	alacritty: new TerminalInfo("alacritty", null, true, true),
+});
+
+export const TERMINAL_ID: TerminalId = (() => {
+	function caseEq(a: string, b: string): boolean {
+		return a.toLowerCase() === b.toLowerCase(); // For compiler to pattern match
+	}
 
-export interface TerminalCapabilities {
-	readonly images: ImageProtocol;
-	readonly trueColor: boolean;
-	readonly hyperlinks: boolean;
-	containsImage(line: string): boolean;
+	const {
+		KITTY_WINDOW_ID,
+		GHOSTTY_RESOURCES_DIR,
+		WEZTERM_PANE,
+		ITERM_SESSION_ID,
+		VSCODE_PID,
+		ALACRITTY_WINDOW_ID,
+		TERM_PROGRAM,
+		TERM,
+		COLORTERM,
+	} = process.env;
+
+	if (KITTY_WINDOW_ID) return "kitty";
+	if (GHOSTTY_RESOURCES_DIR) return "ghostty";
+	if (WEZTERM_PANE) return "wezterm";
+	if (ITERM_SESSION_ID) return "iterm2";
+	if (VSCODE_PID) return "vscode";
+	if (ALACRITTY_WINDOW_ID) return "alacritty";
+
+	if (TERM_PROGRAM) {
+		if (caseEq(TERM_PROGRAM, "kitty")) return "kitty";
+		if (caseEq(TERM_PROGRAM, "ghostty")) return "ghostty";
+		if (caseEq(TERM_PROGRAM, "wezterm")) return "wezterm";
+		if (caseEq(TERM_PROGRAM, "iterm.app")) return "iterm2";
+		if (caseEq(TERM_PROGRAM, "vscode")) return "vscode";
+		if (caseEq(TERM_PROGRAM, "alacritty")) return "alacritty";
+	}
+
+	if (!!TERM && TERM.toLowerCase().includes("ghostty")) return "ghostty";
+
+	if (COLORTERM) {
+		if (caseEq(COLORTERM, "truecolor") || caseEq(COLORTERM, "24bit")) return "trueColor";
+	}
+	return "base";
+})();
+
+export const TERMINAL_INFO = getTerminalInfo(TERMINAL_ID);
+
+export function getTerminalInfo(terminalId: TerminalId): TerminalInfo {
+	return KNOWN_TERMINALS[terminalId];
 }
 
 export interface CellDimensions {
@@ -23,8 +94,6 @@ export interface ImageRenderOptions {
 	preserveAspectRatio?: boolean;
 }
 
-let cachedCapabilities: TerminalCapabilities | null = null;
-
 // Default cell dimensions - updated by TUI when terminal responds to query
 let cellDimensions: CellDimensions = { widthPx: 9, heightPx: 18 };
 
@@ -36,85 +105,6 @@ export function setCellDimensions(dims: CellDimensions): void {
 	cellDimensions = dims;
 }
 
-const kBaseCaps: TerminalCapabilities = {
-	images: null,
-	trueColor: false,
-	hyperlinks: true,
-	containsImage() {
-		return false;
-	},
-};
-
-function createTerminalCaps(parts: Partial<TerminalCapabilities>): TerminalCapabilities {
-	return Object.freeze({ ...kBaseCaps, ...parts });
-}
-
-const kKittyCaps = createTerminalCaps({
-	images: "kitty",
-	trueColor: true,
-	hyperlinks: true,
-	containsImage(line: string) {
-		return line.includes("\x1b_G");
-	},
-});
-const kGhosttyCaps = kKittyCaps;
-const kWeztermCaps = kKittyCaps;
-
-const kIterm2Caps = createTerminalCaps({
-	images: "iterm2",
-	trueColor: true,
-	hyperlinks: true,
-	containsImage(line: string) {
-		return line.includes("\x1b]1337;File=");
-	},
-});
-
-const kTrueColorCaps = createTerminalCaps({
-	...kBaseCaps,
-	trueColor: true,
-});
-
-const kVscodeCaps = kTrueColorCaps;
-const kAlacrittyCaps = kTrueColorCaps;
-
-export function detectCapabilities(): TerminalCapabilities {
-	const termProgram = process.env.TERM_PROGRAM?.toLowerCase() || "";
-	const term = process.env.TERM?.toLowerCase() || "";
-	const colorTerm = process.env.COLORTERM?.toLowerCase() || "";
-
-	if (process.env.KITTY_WINDOW_ID || termProgram === "kitty") {
-		return kKittyCaps;
-	}
-	if (termProgram === "ghostty" || term.includes("ghostty") || process.env.GHOSTTY_RESOURCES_DIR) {
-		return kGhosttyCaps;
-	}
-	if (process.env.WEZTERM_PANE || termProgram === "wezterm") {
-		return kWeztermCaps;
-	}
-	if (process.env.ITERM_SESSION_ID || termProgram === "iterm.app") {
-		return kIterm2Caps;
-	}
-	if (termProgram === "vscode") {
-		return kVscodeCaps;
-	}
-	if (termProgram === "alacritty") {
-		return kAlacrittyCaps;
-	}
-	const trueColor = colorTerm === "truecolor" || colorTerm === "24bit";
-	return trueColor ? kTrueColorCaps : kBaseCaps;
-}
-
-export function getCapabilities(): TerminalCapabilities {
-	if (!cachedCapabilities) {
-		cachedCapabilities = detectCapabilities();
-	}
-	return cachedCapabilities;
-}
-
-export function resetCapabilitiesCache(): void {
-	cachedCapabilities = null;
-}
-
 export function encodeKitty(
 	base64Data: string,
 	options: {
@@ -341,21 +331,19 @@ export function renderImage(
 	imageDimensions: ImageDimensions,
 	options: ImageRenderOptions = {},
 ): { sequence: string; rows: number } | null {
-	const caps = getCapabilities();
-
-	if (!caps.images) {
+	if (!TERMINAL_INFO.imageProtocol) {
 		return null;
 	}
 
 	const maxWidth = options.maxWidthCells ?? 80;
 	const rows = calculateImageRows(imageDimensions, maxWidth, getCellDimensions());
 
-	if (caps.images === "kitty") {
+	if (TERMINAL_INFO.imageProtocol === ImageProtocol.Kitty) {
 		const sequence = encodeKitty(base64Data, { columns: maxWidth, rows });
 		return { sequence, rows };
 	}
 
-	if (caps.images === "iterm2") {
+	if (TERMINAL_INFO.imageProtocol === ImageProtocol.Iterm2) {
 		const sequence = encodeITerm2(base64Data, {
 			width: maxWidth,
 			height: "auto",

package/src/tui.ts

@@ -6,7 +6,7 @@ import * as os from "node:os";
 import * as path from "node:path";
 import { isKeyRelease, matchesKey } from "./keys";
 import type { Terminal } from "./terminal";
-import { getCapabilities, setCellDimensions } from "./terminal-image";
+import { setCellDimensions, TERMINAL_INFO } from "./terminal-image";
 import { extractSegments, sliceByColumn, sliceWithWidth, visibleWidth } from "./utils";
 
 /**
@@ -382,7 +382,7 @@ export class TUI extends Container {
 
 	private queryCellSize(): void {
 		// Only query if terminal supports images (cell size is only used for image rendering)
-		if (!getCapabilities().images) {
+		if (!TERMINAL_INFO.imageProtocol) {
 			return;
 		}
 		// Query terminal for cell size in pixels: CSI 16 t
@@ -542,7 +542,7 @@ export class TUI extends Container {
 	}
 
 	static containsImage(line: string): boolean {
-		return getCapabilities().containsImage(line);
+		return TERMINAL_INFO.isImageLine(line);
 	}
 
 	/**