@opentui/core 0.2.0 → 0.2.1

package/index.js

@@ -70,7 +70,7 @@ import {
   registerCorePlugin,
   resolveCoreSlot,
   vstyles
-} from "./index-mch6dv67.js";
+} from "./index-hxymw48q.js";
 import {
   ASCIIFontSelectionHelper,
   ATTRIBUTE_BASE_BITS,
@@ -245,7 +245,7 @@ import {
   white,
   wrapWithDelegates,
   yellow
-} from "./index-mw2x3082.js";
+} from "./index-b9g14b8c.js";
 export {
   yellow,
   wrapWithDelegates,

package/package.json

@@ -4,7 +4,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "OpenTUI is a TypeScript library on a native Zig core for building terminal user interfaces (TUIs)",
   "license": "MIT",
   "repository": {
@@ -18,11 +18,6 @@
       "require": "./index.js",
       "types": "./index.d.ts"
     },
-    "./3d": {
-      "import": "./3d.js",
-      "require": "./3d.js",
-      "types": "./3d.d.ts"
-    },
     "./testing": {
       "import": "./testing.js",
       "require": "./testing.js",
@@ -46,8 +41,7 @@
   },
   "dependencies": {
     "bun-ffi-structs": "0.1.2",
-    "diff": "8.0.2",
-    "jimp": "1.6.0",
+    "diff": "9.0.0",
     "marked": "17.0.1",
     "string-width": "7.2.0",
     "strip-ansi": "7.1.2",
@@ -57,7 +51,6 @@
     "@opentui/keymap": "workspace:*",
     "@types/bun": "latest",
     "@types/node": "^24.0.0",
-    "@types/three": "0.177.0",
     "commander": "^13.1.0",
     "typescript": "^5",
     "web-tree-sitter": "0.25.10"
@@ -66,15 +59,11 @@
     "web-tree-sitter": "0.25.10"
   },
   "optionalDependencies": {
-    "@dimforge/rapier2d-simd-compat": "^0.17.3",
-    "bun-webgpu": "0.1.7",
-    "planck": "^1.4.2",
-    "three": "0.177.0",
-    "@opentui/core-darwin-x64": "0.2.0",
-    "@opentui/core-darwin-arm64": "0.2.0",
-    "@opentui/core-linux-x64": "0.2.0",
-    "@opentui/core-linux-arm64": "0.2.0",
-    "@opentui/core-win32-x64": "0.2.0",
-    "@opentui/core-win32-arm64": "0.2.0"
+    "@opentui/core-darwin-x64": "0.2.1",
+    "@opentui/core-darwin-arm64": "0.2.1",
+    "@opentui/core-linux-x64": "0.2.1",
+    "@opentui/core-linux-arm64": "0.2.1",
+    "@opentui/core-win32-x64": "0.2.1",
+    "@opentui/core-win32-arm64": "0.2.1"
   }
 }

package/platform/ffi.d.ts

@@ -2,6 +2,10 @@ declare const pointerBrand: unique symbol;
 export type Pointer = (number | bigint) & {
     readonly [pointerBrand]: "Pointer";
 };
+type PointerSource = ArrayBuffer | (ArrayBufferView & {
+    buffer: ArrayBuffer;
+});
+type BunPointer = number;
 export declare const FFIType: {
     readonly char: "char";
     readonly int8_t: "int8_t";
@@ -57,8 +61,66 @@ export interface Library<Fns extends Record<string, FFIFunction>> {
     createCallback(callback: (...args: any[]) => any, definition: FFIFunction): FFICallbackInstance;
     close(): void;
 }
+interface FfiBackend {
+    dlopen<Fns extends Record<string, FFIFunction>>(path: string | URL, symbols: Fns): Library<Fns>;
+    ptr(value: PointerSource): Pointer;
+    suffix: string;
+    toArrayBuffer(pointer: Pointer, offset: number | undefined, length: number): ArrayBuffer;
+}
+interface BunFFIFunction {
+    readonly args?: readonly FFITypeOrString[];
+    readonly returns?: FFITypeOrString;
+    readonly ptr?: BunPointer;
+    readonly threadsafe?: boolean;
+}
+interface BunFfiLibrary<Fns extends Record<string, BunFFIFunction>> {
+    symbols: {
+        [K in keyof Fns]: (...args: any[]) => any;
+    };
+    close(): void;
+}
+interface BunFfiBackend {
+    JSCallback: new (callback: (...args: any[]) => any, definition: BunFFIFunction) => FFICallbackInstance;
+    dlopen<Fns extends Record<string, BunFFIFunction>>(path: string | URL, symbols: Fns): BunFfiLibrary<Fns>;
+    ptr(value: PointerSource): Pointer;
+    suffix: string;
+    toArrayBuffer(pointer: BunPointer, offset: number | undefined, length: number): ArrayBuffer;
+}
+interface NodeFFIFunction {
+    readonly parameters: readonly string[];
+    readonly result: string;
+}
+interface NodeDynamicLibrary {
+    close(): void;
+    registerCallback(signature: NodeFFIFunction, callback: (...args: any[]) => any): bigint;
+    unregisterCallback(pointer: bigint): void;
+}
+interface NodeFfiLibrary {
+    readonly lib: NodeDynamicLibrary;
+    readonly functions: Record<string, (...args: any[]) => any>;
+}
+interface NodeFfiBackend {
+    dlopen(path: string | null, symbols: Record<string, NodeFFIFunction>): NodeFfiLibrary;
+    getRawPointer(source: ArrayBuffer): bigint;
+    suffix: string;
+    toArrayBuffer(pointer: bigint, length: number, copy?: boolean): ArrayBuffer;
+}
+export declare const FFI_UNAVAILABLE = "OpenTUI native FFI is not available for this runtime yet";
+export declare const BUN_DLOPEN_NULL = "Bun FFI backend does not support dlopen(null)";
+export declare const LIBRARY_CLOSED = "Cannot create FFI callback after library.close() has been called";
+export declare const NODE_CALLBACK_THREADSAFE = "Node FFI callbacks are same-thread only and do not support threadsafe callbacks";
+export declare const NODE_NAPI_UNSUPPORTED = "Node FFI backend does not support Bun N-API FFI types";
+export declare const NODE_POINTER_OVERRIDE = "Node FFI backend does not support FFIFunction.ptr overrides";
+export declare const NODE_PTR_VALUE = "node:ffi ptr() only supports ArrayBuffer and ArrayBufferView values backed by ArrayBuffer";
+export declare const NODE_STRING_RETURN = "Node FFI backend does not normalize string return values (yet)";
+export declare const NODE_USIZE_UNSUPPORTED = "Node FFI backend does not support usize until (yet)";
+export declare const POINTER_NEGATIVE = "Pointer must be non-negative";
+export declare const POINTER_UNSAFE = "Pointer exceeds safe integer range";
+export declare function toPointer(value: number | bigint): Pointer;
+export declare function createBunBackend(bun: BunFfiBackend): FfiBackend;
+export declare function createNodeBackend(nodeFfi: NodeFfiBackend): FfiBackend;
 export declare const dlopen: <Fns extends Record<string, FFIFunction>>(path: string | URL, symbols: Fns) => Library<Fns>;
-export declare const ptr: (value: ArrayBufferLike | ArrayBufferView) => Pointer;
+export declare const ptr: (value: PointerSource) => Pointer;
 export declare const suffix: string;
 export declare const toArrayBuffer: (pointer: Pointer, offset: number | undefined, length: number) => ArrayBuffer;
 export {};

package/runtime-plugin-support.js

@@ -2,9 +2,9 @@
 import {
   createRuntimePlugin,
   runtimeModuleIdForSpecifier
-} from "./index-epp5y71w.js";
-import"./index-mch6dv67.js";
-import"./index-mw2x3082.js";
+} from "./index-htg1x5tj.js";
+import"./index-hxymw48q.js";
+import"./index-b9g14b8c.js";
 
 // src/runtime-plugin-support.ts
 var {plugin: registerBunPlugin } = globalThis.Bun;

package/runtime-plugin.js

@@ -3,9 +3,9 @@ import {
   createRuntimePlugin,
   isCoreRuntimeModuleSpecifier,
   runtimeModuleIdForSpecifier
-} from "./index-epp5y71w.js";
-import"./index-mch6dv67.js";
-import"./index-mw2x3082.js";
+} from "./index-htg1x5tj.js";
+import"./index-hxymw48q.js";
+import"./index-b9g14b8c.js";
 export {
   runtimeModuleIdForSpecifier,
   isCoreRuntimeModuleSpecifier,

package/testing.js

@@ -5,7 +5,7 @@ import {
   TreeSitterClient,
   calculateRenderGeometry,
   resolveRenderLib
-} from "./index-mw2x3082.js";
+} from "./index-b9g14b8c.js";
 
 // src/testing/test-renderer.ts
 import { Readable, Writable } from "stream";

package/3d/SpriteResourceManager.d.ts

@@ -1,74 +0,0 @@
-import * as THREE from "three";
-import type { Scene } from "three";
-export interface ResourceConfig {
-    imagePath: string;
-    sheetNumFrames: number;
-}
-export interface SheetProperties {
-    imagePath: string;
-    sheetTilesetWidth: number;
-    sheetTilesetHeight: number;
-    sheetNumFrames: number;
-}
-export interface InstanceManagerOptions {
-    maxInstances: number;
-    renderOrder?: number;
-    depthWrite?: boolean;
-    name?: string;
-    frustumCulled?: boolean;
-    matrix?: THREE.Matrix4;
-}
-export interface MeshPoolOptions {
-    geometry: () => THREE.BufferGeometry;
-    material: THREE.Material;
-    maxInstances: number;
-    name?: string;
-}
-export declare class MeshPool {
-    private pools;
-    acquireMesh(poolId: string, options: MeshPoolOptions): THREE.InstancedMesh;
-    releaseMesh(poolId: string, mesh: THREE.InstancedMesh): void;
-    fill(poolId: string, options: MeshPoolOptions, count: number): void;
-    clearPool(poolId: string): void;
-    clearAllPools(): void;
-}
-export declare class InstanceManager {
-    private scene;
-    private instancedMesh;
-    private material;
-    private maxInstances;
-    private _freeIndices;
-    private instanceCount;
-    private _matrix;
-    constructor(scene: Scene, geometry: THREE.BufferGeometry, material: THREE.Material, options: InstanceManagerOptions);
-    acquireInstanceSlot(): number;
-    releaseInstanceSlot(instanceIndex: number): void;
-    getInstanceCount(): number;
-    getMaxInstances(): number;
-    get hasFreeIndices(): boolean;
-    get mesh(): THREE.InstancedMesh;
-    dispose(): void;
-}
-export declare class SpriteResource {
-    private _texture;
-    private _sheetProperties;
-    private scene;
-    private _meshPool;
-    constructor(texture: THREE.DataTexture, sheetProperties: SheetProperties, scene: Scene);
-    get texture(): THREE.DataTexture;
-    get sheetProperties(): SheetProperties;
-    get meshPool(): MeshPool;
-    createInstanceManager(geometry: THREE.BufferGeometry, material: THREE.Material, options: InstanceManagerOptions): InstanceManager;
-    get uvTileSize(): THREE.Vector2;
-    dispose(): void;
-}
-export declare class SpriteResourceManager {
-    private resources;
-    private textureCache;
-    private scene;
-    constructor(scene: Scene);
-    private getResourceKey;
-    getOrCreateResource(texture: THREE.DataTexture, sheetProps: SheetProperties): Promise<SpriteResource>;
-    createResource(config: ResourceConfig): Promise<SpriteResource>;
-    clearCache(): void;
-}

package/3d/SpriteUtils.d.ts

@@ -1,13 +0,0 @@
-import { Sprite, SpriteMaterial, type SpriteMaterialParameters } from "three";
-export declare class SheetSprite extends Sprite {
-    private _frameIndex;
-    private _numFrames;
-    constructor(material: SpriteMaterial, numFrames: number);
-    setIndex: (index: number) => void;
-}
-export declare class SpriteUtils {
-    static fromFile(path: string, { materialParameters, }?: {
-        materialParameters?: Omit<SpriteMaterialParameters, "map">;
-    }): Promise<Sprite>;
-    static sheetFromFile(path: string, numFrames: number): Promise<SheetSprite>;
-}

package/3d/TextureUtils.d.ts

@@ -1,24 +0,0 @@
-import { Color, Texture, DataTexture } from "three";
-export declare class TextureUtils {
-    /**
-     * Loads a texture from a file path using sharp.
-     * Returns a THREE.Texture with ImageData attached to its .image property.
-     */
-    static loadTextureFromFile(path: string): Promise<DataTexture | null>;
-    /**
-     * Alias for loadTextureFromFile for convenience.
-     */
-    static fromFile(path: string): Promise<DataTexture | null>;
-    /**
-     * Creates a THREE.Texture with a checkerboard pattern.
-     */
-    static createCheckerboard(size?: number, color1?: Color, color2?: Color, checkSize?: number): Texture;
-    /**
-     * Creates a THREE.Texture with a gradient pattern.
-     */
-    static createGradient(size?: number, startColor?: Color, endColor?: Color, direction?: "horizontal" | "vertical" | "radial"): Texture;
-    /**
-     * Creates a THREE.Texture with a procedural noise pattern.
-     */
-    static createNoise(size?: number, scale?: number, octaves?: number, color1?: Color, color2?: Color): Texture;
-}

package/3d/ThreeRenderable.d.ts

@@ -1,40 +0,0 @@
-import { OrthographicCamera, PerspectiveCamera, Scene } from "three";
-import { OptimizedBuffer } from "../buffer.js";
-import { Renderable, type RenderableOptions } from "../Renderable.js";
-import type { RenderContext } from "../types.js";
-import { ThreeCliRenderer, type ThreeCliRendererOptions } from "./WGPURenderer.js";
-export interface ThreeRenderableOptions extends RenderableOptions<ThreeRenderable> {
-    scene?: Scene | null;
-    camera?: PerspectiveCamera | OrthographicCamera;
-    renderer?: Omit<ThreeCliRendererOptions, "width" | "height" | "autoResize">;
-    autoAspect?: boolean;
-}
-export declare class ThreeRenderable extends Renderable {
-    private engine;
-    private scene;
-    private autoAspect;
-    private initPromise;
-    private initFailed;
-    private drawInFlight;
-    private frameCallback;
-    private frameCallbackRegistered;
-    private cliRenderer;
-    private clearColor;
-    constructor(ctx: RenderContext, options: ThreeRenderableOptions);
-    get aspectRatio(): number;
-    get renderer(): ThreeCliRenderer;
-    getScene(): Scene | null;
-    setScene(scene: Scene | null): void;
-    getActiveCamera(): PerspectiveCamera | OrthographicCamera;
-    setActiveCamera(camera: PerspectiveCamera | OrthographicCamera): void;
-    setAutoAspect(autoAspect: boolean): void;
-    protected onResize(width: number, height: number): void;
-    protected renderSelf(buffer: OptimizedBuffer, deltaTime: number): void;
-    protected destroySelf(): void;
-    private registerFrameCallback;
-    private renderToBuffer;
-    private ensureInitialized;
-    private updateCameraAspect;
-    private getAspectRatio;
-    private getRenderSize;
-}

package/3d/WGPURenderer.d.ts

@@ -1,61 +0,0 @@
-import { PerspectiveCamera, OrthographicCamera, Scene } from "three";
-import type { OptimizedBuffer } from "../buffer.js";
-import { RGBA } from "../lib/RGBA.js";
-import { SuperSampleAlgorithm } from "./canvas.js";
-import { type CliRenderer } from "../renderer.js";
-export declare enum SuperSampleType {
-    NONE = "none",
-    GPU = "gpu",
-    CPU = "cpu"
-}
-export interface ThreeCliRendererOptions {
-    width: number;
-    height: number;
-    focalLength?: number;
-    backgroundColor?: RGBA;
-    superSample?: SuperSampleType;
-    alpha?: boolean;
-    autoResize?: boolean;
-    libPath?: string;
-}
-export declare class ThreeCliRenderer {
-    private readonly cliRenderer;
-    private outputWidth;
-    private outputHeight;
-    private renderWidth;
-    private renderHeight;
-    private superSample;
-    private backgroundColor;
-    private alpha;
-    private threeRenderer?;
-    private canvas?;
-    private device;
-    private activeCamera;
-    private _aspectRatio;
-    private doRenderStats;
-    private resizeHandler;
-    private debugToggleHandler;
-    private destroyHandler;
-    private renderTimeMs;
-    private readbackTimeMs;
-    private totalDrawTimeMs;
-    private renderMethod;
-    get aspectRatio(): number;
-    constructor(cliRenderer: CliRenderer, options: ThreeCliRendererOptions);
-    toggleDebugStats(): void;
-    init(): Promise<void>;
-    getSuperSampleAlgorithm(): SuperSampleAlgorithm;
-    setSuperSampleAlgorithm(superSampleAlgorithm: SuperSampleAlgorithm): void;
-    saveToFile(filePath: string): Promise<void>;
-    setActiveCamera(camera: PerspectiveCamera | OrthographicCamera): void;
-    getActiveCamera(): PerspectiveCamera | OrthographicCamera;
-    setBackgroundColor(color: RGBA): void;
-    setSize(width: number, height: number, forceUpdate?: boolean): void;
-    drawScene(root: Scene, buffer: OptimizedBuffer, deltaTime: number): Promise<void>;
-    private rendering;
-    private destroyed;
-    doDrawScene(root: Scene, camera: PerspectiveCamera | OrthographicCamera, buffer: OptimizedBuffer, deltaTime: number): Promise<void>;
-    toggleSuperSampling(): void;
-    renderStats(buffer: OptimizedBuffer): void;
-    destroy(): void;
-}

package/3d/animation/ExplodingSpriteEffect.d.ts

@@ -1,71 +0,0 @@
-import * as THREE from "three";
-import { NodeMaterial } from "three/webgpu";
-import type { TiledSprite, SpriteDefinition, SpriteAnimator } from "./SpriteAnimator.js";
-import type { SpriteResource } from "../SpriteResourceManager.js";
-export interface ExplosionEffectParameters {
-    numRows: number;
-    numCols: number;
-    durationMs: number;
-    strength: number;
-    strengthVariation: number;
-    gravity: number;
-    gravityScale: number;
-    fadeOut: boolean;
-    angularVelocityMin: THREE.Vector3;
-    angularVelocityMax: THREE.Vector3;
-    initialVelocityYBoost: number;
-    zVariationStrength: number;
-    materialFactory: () => NodeMaterial;
-}
-export declare const DEFAULT_EXPLOSION_PARAMETERS: ExplosionEffectParameters;
-export interface ExplosionCreationData {
-    resource: SpriteResource;
-    frameUvOffset: THREE.Vector2;
-    frameUvSize: THREE.Vector2;
-    spriteWorldTransform: THREE.Matrix4;
-}
-export interface SpriteRecreationData {
-    definition: SpriteDefinition;
-    currentTransform: {
-        position: THREE.Vector3;
-        quaternion: THREE.Quaternion;
-        scale: THREE.Vector3;
-    };
-}
-export interface ExplosionHandle {
-    readonly effect: ExplodingSpriteEffect;
-    readonly recreationData: SpriteRecreationData;
-    hasBeenRestored: boolean;
-    restoreSprite: (spriteAnimator: SpriteAnimator) => Promise<TiledSprite | null>;
-}
-export declare class ExplodingSpriteEffect {
-    private static baseMaterialCache;
-    private scene;
-    private resource;
-    private frameUvOffset;
-    private frameUvSize;
-    private spriteWorldTransform;
-    private params;
-    private instancedMesh;
-    private material;
-    private numParticles;
-    private uniformRefs;
-    isActive: boolean;
-    private timeElapsedMs;
-    constructor(scene: THREE.Scene, resource: SpriteResource, frameUvOffset: THREE.Vector2, frameUvSize: THREE.Vector2, spriteWorldTransform: THREE.Matrix4, userParams?: Partial<ExplosionEffectParameters>);
-    private _createGPUParticles;
-    private _createGPUMaterial;
-    static _buildTemplateMaterial(texture: THREE.DataTexture, params: ExplosionEffectParameters, materialFactory: () => NodeMaterial): NodeMaterial;
-    update(deltaTimeMs: number): void;
-    dispose(): void;
-}
-export declare class ExplosionManager {
-    private scene;
-    private activeExplosions;
-    constructor(scene: THREE.Scene);
-    fillPool(resource: SpriteResource, count: number, params?: Partial<ExplosionEffectParameters>): void;
-    private _createEffectCreationData;
-    createExplosionForSprite(spriteToExplode: TiledSprite, userParams?: Partial<ExplosionEffectParameters>): ExplosionHandle | null;
-    update(deltaTimeMs: number): void;
-    disposeAll(): void;
-}

package/3d/animation/PhysicsExplodingSpriteEffect.d.ts

@@ -1,76 +0,0 @@
-import * as THREE from "three";
-import { NodeMaterial } from "three/webgpu";
-import type { TiledSprite, SpriteDefinition, SpriteAnimator } from "./SpriteAnimator.js";
-import type { PhysicsWorld } from "../physics/physics-interface.js";
-import type { SpriteResource } from "../SpriteResourceManager.js";
-export interface PhysicsExplosionEffectParameters {
-    numRows: number;
-    numCols: number;
-    durationMs: number;
-    explosionForce: number;
-    forceVariation: number;
-    torqueStrength: number;
-    gravityScale: number;
-    fadeOut: boolean;
-    linearDamping: number;
-    angularDamping: number;
-    restitution: number;
-    friction: number;
-    density: number;
-    materialFactory: () => NodeMaterial;
-}
-export declare const DEFAULT_PHYSICS_EXPLOSION_PARAMETERS: PhysicsExplosionEffectParameters;
-export interface PhysicsExplosionCreationData {
-    resource: SpriteResource;
-    frameUvOffset: THREE.Vector2;
-    frameUvSize: THREE.Vector2;
-    spriteWorldTransform: THREE.Matrix4;
-}
-export interface PhysicsSpriteRecreationData {
-    definition: SpriteDefinition;
-    currentTransform: {
-        position: THREE.Vector3;
-        quaternion: THREE.Quaternion;
-        scale: THREE.Vector3;
-    };
-}
-export interface PhysicsExplosionHandle {
-    readonly effect: PhysicsExplodingSpriteEffect;
-    readonly recreationData: PhysicsSpriteRecreationData;
-    hasBeenRestored: boolean;
-    restoreSprite: (spriteAnimator: SpriteAnimator) => Promise<TiledSprite | null>;
-}
-export declare class PhysicsExplodingSpriteEffect {
-    private static materialCache;
-    private scene;
-    private physicsWorld;
-    private resource;
-    private frameUvOffset;
-    private frameUvSize;
-    private spriteWorldTransform;
-    private params;
-    private particles;
-    private numParticles;
-    private instancedMesh;
-    private material;
-    private uvOffsetAttribute;
-    isActive: boolean;
-    private timeElapsedMs;
-    private particleIdCounter;
-    constructor(scene: THREE.Scene, physicsWorld: PhysicsWorld, resource: SpriteResource, frameUvOffset: THREE.Vector2, frameUvSize: THREE.Vector2, spriteWorldTransform: THREE.Matrix4, userParams?: Partial<PhysicsExplosionEffectParameters>);
-    private _createPhysicsParticles;
-    static getSharedMaterial(texture: THREE.DataTexture, materialFactory: () => NodeMaterial): NodeMaterial;
-    update(deltaTimeMs: number): void;
-    dispose(): void;
-}
-export declare class PhysicsExplosionManager {
-    private scene;
-    private physicsWorld;
-    private activeExplosions;
-    constructor(scene: THREE.Scene, physicsWorld: PhysicsWorld);
-    fillPool(resource: SpriteResource, count: number, params?: Partial<PhysicsExplosionEffectParameters>): void;
-    private _createEffectCreationData;
-    createExplosionForSprite(spriteToExplode: TiledSprite, userParams?: Partial<PhysicsExplosionEffectParameters>): Promise<PhysicsExplosionHandle | null>;
-    update(deltaTimeMs: number): void;
-    disposeAll(): void;
-}