@opentui/core 0.5.7 → 0.5.8

package/README.md

@@ -1,63 +1,70 @@
-# OpenTUI Core
+<!-- Keep the project introduction aligned with the repository README and opentui.com. -->
 
-OpenTUI is a native terminal UI core written in Zig with TypeScript bindings. The native core exposes a C ABI and can be used from any language. OpenTUI powers OpenCode in production today and will also power terminal.shop. It is an extensible core with a focus on correctness, stability, and high performance. It provides a component-based architecture with flexible layout capabilities, allowing you to create complex terminal applications.
+<p align="center">
+  <a href="https://opentui.com">
+    <img alt="OpenTUI logo" src="https://opentui.com/opentui-logo-auto.svg" width="270" />
+  </a>
+</p>
 
-## Documentation
+<div align="center">
+    <a href="https://www.npmjs.com/package/@opentui/core"><img alt="npm version" src="https://img.shields.io/npm/v/@opentui/core?style=flat-square" /></a>
+    <a href="https://github.com/anomalyco/opentui/actions/workflows/build-core.yml"><img alt="Core build status" src="https://img.shields.io/github/actions/workflow/status/anomalyco/opentui/build-core.yml?style=flat-square&branch=main" /></a>
+</div>
 
-- [Getting Started](https://opentui.com/docs/getting-started) - API and usage guide
-- [Development Guide](docs/development.md) - Building, testing, and contributing
-- [Tree-Sitter](https://opentui.com/docs/reference/tree-sitter) - Syntax highlighting integration
-- [Renderables](https://opentui.com/docs/core-concepts/renderables) - Understanding the component model
-- [Environment Variables](https://opentui.com/docs/reference/env-vars) - Configuration options
+OpenTUI is a library to build terminal user interfaces.
 
-## Install
+- It is written in Zig.
+- You write TypeScript directly or through React and Solid.
+- You arrange boxes and text with flexbox.
+- You add selects, inputs, and scroll boxes with keyboard and mouse controls.
+- You can play sounds, show images, and render 3D graphics.
 
-```bash
-bun install @opentui/core
-```
+OpenCode uses OpenTUI in production for millions of users.
 
-## Build
+[Website](https://opentui.com) | [Documentation](https://opentui.com/docs) | [Packages](https://opentui.com/packages)
 
-```bash
-bun run build
-```
+## OpenTUI Core
 
-This creates platform-specific libraries that are automatically loaded by the TypeScript layer.
+`@opentui/core` supplies the renderer and TypeScript API. You use imperative renderables and events directly. The
+TypeScript packages call native Zig through an internal foreign function interface (FFI) boundary.
 
-## Examples
+```typescript
+import { TextRenderable, createCliRenderer } from "@opentui/core"
 
-```bash
-bun install
-cd ../examples
-bun run dev
+const renderer = await createCliRenderer({ exitOnCtrlC: true })
+
+renderer.root.add(new TextRenderable(renderer, { content: "Hello, OpenTUI!" }))
 ```
 
-## Benchmarks
+`exitOnCtrlC: true` calls `renderer.destroy()` when the user presses Ctrl+C. The code that creates the renderer must
+call `renderer.destroy()` on every other shutdown path.
 
-Run native performance benchmarks:
+Install the package:
 
 ```bash
-bun run bench:native
+bun add @opentui/core
 ```
 
-See [the native benchmark runner](../native/src/bench.zig) for options such as `--filter` and `--mem`.
+Then build your first app with the [quickstart](https://opentui.com/docs/getting-started/quickstart).
 
-NativeSpanFeed TypeScript benchmarks:
+## Runtime and platform support
 
-- [src/benchmark/native-span-feed-benchmark.md](src/benchmark/native-span-feed-benchmark.md)
+`@opentui/core` runs on Bun 1.3.0 or later, or on Node.js 26.4.0 or later with ECMAScript modules (ESM) and
+`--experimental-ffi`.
 
-## CLI Renderer
+The native ABI and the generated platform packages, such as `@opentui/core-linux-x64`, are internal distribution
+surfaces, not application APIs.
 
-### Renderables
+## AI agent skill
 
-Renderables are hierarchical objects that can be positioned, nested, styled and rendered to the terminal:
+Install the OpenTUI documentation as a skill for your AI coding assistant with [`npx skills`](https://skills.sh):
 
-```typescript
-import { createCliRenderer, TextRenderable } from "@opentui/core"
+```bash
+npx skills add anomalyco/opentui --skill opentui
+```
 
-const renderer = await createCliRenderer()
+Add `-g` to install the skill globally.
 
-const obj = new TextRenderable(renderer, { id: "my-obj", content: "Hello, world!" })
+## License
 
-renderer.root.add(obj)
-```
+OpenTUI is licensed under the [MIT License](https://github.com/anomalyco/opentui/blob/main/LICENSE).

package/{chunk-bun-xmsp0nqq.js → chunk-bun-2956gvaq.js}

@@ -5965,7 +5965,7 @@ class MouseParser {
       if (type === "down" && button !== 3) {
         this.mouseButtonsPressed.add(button);
       } else if (type === "up") {
-        this.mouseButtonsPressed.clear();
+        this.mouseButtonsPressed.delete(button);
       }
     }
     return {
@@ -13120,7 +13120,7 @@ var VisualCursorStruct = defineStruct([
   ["logicalCol", "u32"],
   ["offset", "u32"]
 ]);
-var UnicodeMethodEnum = defineEnum({ wcwidth: 0, unicode: 1 }, "u8");
+var UnicodeMethodEnum = defineEnum({ wcwidth: 0, unicode: 1, "unicode-wide": 3 }, "u8");
 var TerminalMultiplexerEnum = defineEnum({ none: 0, tmux: 1, zellij: 2, screen: 3, unknown: 4 }, "u8");
 var Osc52SupportEnum = defineEnum({ unknown: 0, supported: 1, unsupported: 2 }, "u8");
 var ImageProtocolEnum = defineEnum({ auto: 0, kitty: 1, sixel: 2, blocks: 3 }, "u8");
@@ -13594,6 +13594,14 @@ function selectionBehaviorByte(behavior) {
 function editorLocalSelectionFlags(updateCursor, followCursor, behavior) {
   return ffiBool(updateCursor) | ffiBool(followCursor) << 1 | selectionBehaviorByte(behavior) << 2;
 }
+function widthMethodCode(widthMethod) {
+  return widthMethod === "wcwidth" ? 0 : widthMethod === "unicode-wide" ? 3 : 1;
+}
+function widthMethodFromCode(code) {
+  if (code === 0)
+    return "wcwidth";
+  return code === 3 ? "unicode-wide" : "unicode";
+}
 function getOpenTUILib(libPath) {
   const resolvedLibPath = libPath || targetLibPath;
   if (!resolvedLibPath) {
@@ -13804,6 +13812,10 @@ function getOpenTUILib(libPath) {
       args: ["u32"],
       returns: "u32"
     },
+    getBufferWidthMethod: {
+      args: ["u32"],
+      returns: "u8"
+    },
     bufferClear: {
       args: ["u32", "buffer"],
       returns: "void"
@@ -15780,7 +15792,8 @@ class FFIRenderLib {
     }
     const width = this.opentui.symbols.getBufferWidth(bufferPtr);
     const height = this.opentui.symbols.getBufferHeight(bufferPtr);
-    return new OptimizedBuffer(this, bufferPtr, width, height, { id: "next buffer", widthMethod: "unicode" });
+    const widthMethod = widthMethodFromCode(this.opentui.symbols.getBufferWidthMethod(bufferPtr));
+    return new OptimizedBuffer(this, bufferPtr, width, height, { id: "next buffer", widthMethod });
   }
   getCurrentBuffer(renderer) {
     const bufferPtr = this.opentui.symbols.getCurrentBuffer(renderer);
@@ -15789,7 +15802,8 @@ class FFIRenderLib {
     }
     const width = this.opentui.symbols.getBufferWidth(bufferPtr);
     const height = this.opentui.symbols.getBufferHeight(bufferPtr);
-    return new OptimizedBuffer(this, bufferPtr, width, height, { id: "current buffer", widthMethod: "unicode" });
+    const widthMethod = widthMethodFromCode(this.opentui.symbols.getBufferWidthMethod(bufferPtr));
+    return new OptimizedBuffer(this, bufferPtr, width, height, { id: "current buffer", widthMethod });
   }
   rendererSetPaletteState(renderer, palette, defaultForeground, defaultBackground, paletteEpoch) {
     const paletteBuffer = new Uint16Array(palette.length * 4);
@@ -15993,10 +16007,9 @@ class FFIRenderLib {
     if (Number.isNaN(width) || Number.isNaN(height)) {
       console.error(new Error(`Invalid dimensions for OptimizedBuffer: ${width}x${height}`).stack);
     }
-    const widthMethodCode = widthMethod === "wcwidth" ? 0 : 1;
     const idToUse = id || "unnamed buffer";
     const idBytes = this.encoder.encode(idToUse);
-    const bufferPtr = this.opentui.symbols.createOptimizedBuffer(width, height, ffiBool(respectAlpha), widthMethodCode, idBytes, idBytes.byteLength);
+    const bufferPtr = this.opentui.symbols.createOptimizedBuffer(width, height, ffiBool(respectAlpha), widthMethodCode(widthMethod), idBytes, idBytes.byteLength);
     if (!bufferPtr) {
       throw new Error(`Failed to create optimized buffer: ${width}x${height}`);
     }
@@ -16386,8 +16399,7 @@ class FFIRenderLib {
     });
   }
   createTextBuffer(widthMethod) {
-    const widthMethodCode = widthMethod === "wcwidth" ? 0 : 1;
-    const bufferPtr = this.opentui.symbols.createTextBuffer(widthMethodCode);
+    const bufferPtr = this.opentui.symbols.createTextBuffer(widthMethodCode(widthMethod));
     if (!bufferPtr) {
       throw new Error(`Failed to create TextBuffer`);
     }
@@ -16789,8 +16801,7 @@ class FFIRenderLib {
     };
   }
   createEditBuffer(widthMethod) {
-    const widthMethodCode = widthMethod === "wcwidth" ? 0 : 1;
-    const bufferPtr = this.opentui.symbols.createEditBuffer(widthMethodCode, this.eventSinkPtr ?? 0);
+    const bufferPtr = this.opentui.symbols.createEditBuffer(widthMethodCode(widthMethod), this.eventSinkPtr ?? 0);
     if (!bufferPtr) {
       throw new Error("Failed to create EditBuffer");
     }
@@ -17145,10 +17156,9 @@ class FFIRenderLib {
   }
   encodeUnicode(text, widthMethod) {
     const textBytes = this.encoder.encode(text);
-    const widthMethodCode = widthMethod === "wcwidth" ? 0 : 1;
     const outPtrBuffer = new ArrayBuffer(8);
     const outLenBuffer = new ArrayBuffer(8);
-    const success = this.opentui.symbols.encodeUnicode(viewOrNull(textBytes), textBytes.byteLength, outPtrBuffer, outLenBuffer, widthMethodCode);
+    const success = this.opentui.symbols.encodeUnicode(viewOrNull(textBytes), textBytes.byteLength, outPtrBuffer, outLenBuffer, widthMethodCode(widthMethod));
     if (!success) {
       return null;
     }
@@ -18599,5 +18609,5 @@ var yoga_default = Yoga;
 
 export { toArrayBuffer, singleton, envRegistry, registerEnvVar, clearEnvCache, generateEnvMarkdown, generateEnvColored, env, sleep, stringWidth2 as stringWidth, resolveBundledFilePath, DEFAULT_FOREGROUND_RGB, DEFAULT_BACKGROUND_RGB, normalizeIndexedColorIndex, ansi256IndexToRgb, RGBA, normalizeColorValue, hexToRgb, rgbToHex, hsvToRgb, parseColor, isValidBorderStyle, parseBorderStyle, BorderChars, getBorderFromSides, getBorderSides, borderCharsToArray, BorderCharArrays, KeyEvent, PasteEvent, KeyHandler, InternalKeyHandler, fonts, measureText, getCharacterPositions, coordinateToCharacterIndex, renderFontToFrameBuffer, TextAttributes, ATTRIBUTE_BASE_BITS, ATTRIBUTE_BASE_MASK, getBaseAttributes, DebugOverlayCorner, TargetChannel, createTextAttributes, attributesWithLink, getLinkId, 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, link, t, hastToStyledText, SystemClock, nonAlphanumericKeys, terminalNamedSingleStrokeKeys, parseKeypress, LinearScrollAccel, MacOSScrollAccel, parseAlign, parseAlignItems, parseBoxSizing, parseDimension, parseDirection, parseDisplay, parseEdge, parseFlexDirection, parseGutter, parseJustify, parseLogLevel, parseMeasureMode, parseOverflow, parsePositionType, parseUnit, parseWrap, MouseParser, Selection, convertGlobalToLocalSelection, ASCIIFontSelectionHelper, StdinParser, treeSitterToTextChunks, treeSitterToStyledText, addDefaultParsers, TreeSitterClient, DataPathsManager, getDataPaths, extensionToFiletype, basenameToFiletype, extToFiletype, pathToFiletype, infoStringToFiletype, getTreeSitterClient, destroyTreeSitterClient, ExtmarksController, createExtmarksController, TerminalPalette, createTerminalPalette, normalizeTerminalPalette, buildTerminalPaletteSignature, decodePasteBytes, stripAnsiSequences, createHostClipboard, createClipboard, ClipboardTarget, createRendererClipboardAdapter, Clipboard, detectLinks, OptimizedBuffer, TextBuffer, SpanInfoStruct, NativeAudioStreamFormat, NativeAudioStreamState, NativeAudioStreamStateNames, NativeAudioStreamCloseReason, NativeAudioStreamState2 as NativeAudioStreamState1, NativeAudioStreamCloseReason2 as NativeAudioStreamCloseReason1, NativeAudioStreamFormat2 as NativeAudioStreamFormat1, NativeClipboardOperationStatus, NativeClipboardStartStatus, NativeClipboardCancelStatus, NativeClipboardCopyStatus, NativeClipboardDestroyStatus, NativeClipboardShutdownStatus, LogLevel2 as LogLevel, NativeMeasureTargetKind, setRenderLibPath, resolveRenderLib, Align, BoxSizing, Dimension, Direction, Display, Edge, Errata, ExperimentalFeature, FlexDirection, Gutter, Justify, LogLevel as LogLevel1, MeasureMode, NodeType, Overflow, PositionType, Unit, Wrap, ALIGN_AUTO, ALIGN_FLEX_START, ALIGN_CENTER, ALIGN_FLEX_END, ALIGN_STRETCH, ALIGN_BASELINE, ALIGN_SPACE_BETWEEN, ALIGN_SPACE_AROUND, ALIGN_SPACE_EVENLY, BOX_SIZING_BORDER_BOX, BOX_SIZING_CONTENT_BOX, DIMENSION_WIDTH, DIMENSION_HEIGHT, DIRECTION_INHERIT, DIRECTION_LTR, DIRECTION_RTL, DISPLAY_FLEX, DISPLAY_NONE, DISPLAY_CONTENTS, EDGE_LEFT, EDGE_TOP, EDGE_RIGHT, EDGE_BOTTOM, EDGE_START, EDGE_END, EDGE_HORIZONTAL, EDGE_VERTICAL, EDGE_ALL, ERRATA_NONE, ERRATA_STRETCH_FLEX_BASIS, ERRATA_ABSOLUTE_POSITION_WITHOUT_INSETS_EXCLUDES_PADDING, ERRATA_ABSOLUTE_PERCENT_AGAINST_INNER_SIZE, ERRATA_ALL, ERRATA_CLASSIC, EXPERIMENTAL_FEATURE_WEB_FLEX_BASIS, FLEX_DIRECTION_COLUMN, FLEX_DIRECTION_COLUMN_REVERSE, FLEX_DIRECTION_ROW, FLEX_DIRECTION_ROW_REVERSE, GUTTER_COLUMN, GUTTER_ROW, GUTTER_ALL, JUSTIFY_FLEX_START, JUSTIFY_CENTER, JUSTIFY_FLEX_END, JUSTIFY_SPACE_BETWEEN, JUSTIFY_SPACE_AROUND, JUSTIFY_SPACE_EVENLY, LOG_LEVEL_ERROR, LOG_LEVEL_WARN, LOG_LEVEL_INFO, LOG_LEVEL_DEBUG, LOG_LEVEL_VERBOSE, LOG_LEVEL_FATAL, MEASURE_MODE_UNDEFINED, MEASURE_MODE_EXACTLY, MEASURE_MODE_AT_MOST, NODE_TYPE_DEFAULT, NODE_TYPE_TEXT, OVERFLOW_VISIBLE, OVERFLOW_HIDDEN, OVERFLOW_SCROLL, POSITION_TYPE_STATIC, POSITION_TYPE_RELATIVE, POSITION_TYPE_ABSOLUTE, UNIT_UNDEFINED, UNIT_POINT, UNIT_PERCENT, UNIT_AUTO, WRAP_NO_WRAP, WRAP_WRAP, WRAP_WRAP_REVERSE, Config, Node, exports_yoga, yoga_default };
 
-//# debugId=CCD1F52D948CB76B64756E2164756E21
-//# sourceMappingURL=chunk-bun-xmsp0nqq.js.map
+//# debugId=629581C67E2214E264756E2164756E21
+//# sourceMappingURL=chunk-bun-2956gvaq.js.map