@gridland/web 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,557 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import { ReactNode, CSSProperties } from 'react';
+import { EventEmitter } from 'events';
+
+declare class RGBA {
+    buffer: Float32Array;
+    constructor(buffer: Float32Array);
+    static fromArray(array: Float32Array): RGBA;
+    static fromValues(r: number, g: number, b: number, a?: number): RGBA;
+    static fromInts(r: number, g: number, b: number, a?: number): RGBA;
+    static fromHex(hex: string): RGBA;
+    get r(): number;
+    set r(v: number);
+    get g(): number;
+    set g(v: number);
+    get b(): number;
+    set b(v: number);
+    get a(): number;
+    set a(v: number);
+    toInts(): [number, number, number, number];
+    map<R>(fn: (value: number) => R): R[];
+    toString(): string;
+    equals(other?: RGBA): boolean;
+}
+
+type CursorStyle = "block" | "line" | "underline";
+type MousePointerStyle = "default" | "pointer" | "text" | "crosshair" | "move" | "not-allowed";
+type WidthMethod$1 = "wcwidth" | "unicode";
+interface CursorStyleOptions {
+    style?: CursorStyle;
+    blinking?: boolean;
+    color?: RGBA;
+    cursor?: MousePointerStyle;
+}
+interface RenderContext {
+    addToHitGrid: (x: number, y: number, width: number, height: number, id: number) => void;
+    pushHitGridScissorRect: (x: number, y: number, width: number, height: number) => void;
+    popHitGridScissorRect: () => void;
+    clearHitGridScissorRects: () => void;
+    width: number;
+    height: number;
+    requestRender: () => void;
+    setCursorPosition: (x: number, y: number, visible: boolean) => void;
+    setCursorStyle: (options: CursorStyleOptions) => void;
+    setCursorColor: (color: RGBA) => void;
+    setMousePointer: (shape: MousePointerStyle) => void;
+    widthMethod: WidthMethod$1;
+    capabilities: any | null;
+    requestLive: () => void;
+    dropLive: () => void;
+    hasSelection: boolean;
+    getSelection: () => any | null;
+    requestSelectionUpdate: () => void;
+    currentFocusedRenderable: any | null;
+    focusRenderable: (renderable: any) => void;
+    registerLifecyclePass: (renderable: any) => void;
+    unregisterLifecyclePass: (renderable: any) => void;
+    getLifecyclePasses: () => Set<any>;
+    keyInput: any;
+    _internalKeyInput: any;
+    clearSelection: () => void;
+    startSelection: (renderable: any, x: number, y: number) => void;
+    updateSelection: (currentRenderable: any | undefined, x: number, y: number, options?: {
+        finishDragging?: boolean;
+    }) => void;
+    on: (event: string, listener: (...args: any[]) => void) => any;
+    off: (event: string, listener: (...args: any[]) => void) => any;
+    emit: (event: string, ...args: any[]) => boolean;
+    removeAllListeners: (event?: string) => any;
+}
+interface CapturedSpan {
+    text: string;
+    fg: RGBA;
+    bg: RGBA;
+    attributes: number;
+    width: number;
+}
+interface CapturedLine {
+    spans: CapturedSpan[];
+}
+
+type WidthMethod = "wcwidth" | "unicode";
+interface BorderDrawOptions {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    borderStyle?: string;
+    customBorderChars?: Uint32Array;
+    border: boolean | string[];
+    borderColor: RGBA;
+    backgroundColor: RGBA;
+    shouldFill?: boolean;
+    title?: string;
+    titleAlignment?: "left" | "center" | "right";
+}
+declare class BrowserBuffer {
+    id: string;
+    respectAlpha: boolean;
+    private _width;
+    private _height;
+    private _widthMethod;
+    char: Uint32Array;
+    fg: Float32Array;
+    bg: Float32Array;
+    attributes: Uint32Array;
+    private scissorStack;
+    private opacityStack;
+    linkRegistry: Map<number, string>;
+    private nextLinkId;
+    constructor(width: number, height: number, options?: {
+        respectAlpha?: boolean;
+        id?: string;
+        widthMethod?: WidthMethod;
+    });
+    static create(width: number, height: number, widthMethod: WidthMethod, options?: {
+        respectAlpha?: boolean;
+        id?: string;
+    }): BrowserBuffer;
+    get width(): number;
+    get height(): number;
+    get widthMethod(): WidthMethod;
+    get ptr(): number;
+    get buffers(): {
+        char: Uint32Array<ArrayBufferLike>;
+        fg: Float32Array<ArrayBufferLike>;
+        bg: Float32Array<ArrayBufferLike>;
+        attributes: Uint32Array<ArrayBufferLike>;
+    };
+    setRespectAlpha(respectAlpha: boolean): void;
+    getNativeId(): string;
+    registerLink(url: string): number;
+    getLinkUrl(linkId: number): string | undefined;
+    private isInScissor;
+    private getCurrentOpacityMultiplier;
+    private applyOpacity;
+    clear(bg?: RGBA): void;
+    setCell(x: number, y: number, char: string, fgColor: RGBA, bgColor: RGBA, attr?: number): void;
+    setCellWithAlphaBlending(x: number, y: number, char: string, fgColor: RGBA, bgColor: RGBA, attr?: number): void;
+    drawChar(charCode: number, x: number, y: number, fgColor: RGBA, bgColor: RGBA, attr?: number): void;
+    drawText(text: string, x: number, y: number, fgColor: RGBA, bgColor?: RGBA, attr?: number, _selection?: {
+        start: number;
+        end: number;
+        bgColor?: RGBA;
+        fgColor?: RGBA;
+    } | null): void;
+    fillRect(x: number, y: number, width: number, height: number, bgColor: RGBA): void;
+    drawBox(options: BorderDrawOptions): void;
+    private getDefaultBorderChars;
+    pushScissorRect(x: number, y: number, width: number, height: number): void;
+    popScissorRect(): void;
+    clearScissorRects(): void;
+    pushOpacity(opacity: number): void;
+    popOpacity(): void;
+    getCurrentOpacity(): number;
+    clearOpacity(): void;
+    resize(width: number, height: number): void;
+    getSpanLines(): CapturedLine[];
+    drawTextBufferView(view: any, x: number, y: number): void;
+    drawTextBuffer(textBufferView: any, x: number, y: number): void;
+    drawFrameBuffer(destX: number, destY: number, frameBuffer: BrowserBuffer, sourceX?: number, sourceY?: number, sourceWidth?: number, sourceHeight?: number): void;
+    drawEditorView(editorView: any, x: number, y: number): void;
+    drawSuperSampleBuffer(): void;
+    drawPackedBuffer(): void;
+    drawGrayscaleBuffer(): void;
+    drawGrayscaleBufferSupersampled(): void;
+    drawGrid(): void;
+    encodeUnicode(_text: string): null;
+    freeUnicode(): void;
+    getRealCharBytes(): Uint8Array;
+    destroy(): void;
+}
+
+declare class BrowserKeyHandler extends EventEmitter {
+    constructor();
+    processInput(_data: string): boolean;
+}
+declare class BrowserInternalKeyHandler extends BrowserKeyHandler {
+    private renderableHandlers;
+    onInternal(event: string, handler: Function): void;
+    offInternal(event: string, handler: Function): void;
+    emit(event: string, ...args: any[]): boolean;
+}
+declare class BrowserRenderContext extends EventEmitter implements RenderContext {
+    private _width;
+    private _height;
+    private _widthMethod;
+    private _renderRequested;
+    private _onRenderRequest;
+    private _lifecyclePasses;
+    private _focusedRenderable;
+    keyInput: BrowserKeyHandler;
+    _internalKeyInput: BrowserInternalKeyHandler;
+    constructor(width: number, height: number, widthMethod?: WidthMethod$1);
+    get width(): number;
+    get height(): number;
+    get widthMethod(): WidthMethod$1;
+    get capabilities(): any;
+    get hasSelection(): boolean;
+    get currentFocusedRenderable(): any | null;
+    setOnRenderRequest(callback: () => void): void;
+    resize(width: number, height: number): void;
+    addToHitGrid(_x: number, _y: number, _width: number, _height: number, _id: number): void;
+    pushHitGridScissorRect(_x: number, _y: number, _width: number, _height: number): void;
+    popHitGridScissorRect(): void;
+    clearHitGridScissorRects(): void;
+    requestRender(): void;
+    setCursorPosition(_x: number, _y: number, _visible: boolean): void;
+    setCursorStyle(_options: CursorStyleOptions): void;
+    setCursorColor(_color: RGBA): void;
+    setMousePointer(_shape: MousePointerStyle): void;
+    requestLive(): void;
+    dropLive(): void;
+    getSelection(): any | null;
+    requestSelectionUpdate(): void;
+    focusRenderable(renderable: any): void;
+    registerLifecyclePass(renderable: any): void;
+    unregisterLifecyclePass(renderable: any): void;
+    getLifecyclePasses(): Set<any>;
+    clearSelection(): void;
+    startSelection(_renderable: any, _x: number, _y: number): void;
+    updateSelection(_currentRenderable: any | undefined, _x: number, _y: number, _options?: {
+        finishDragging?: boolean;
+    }): void;
+}
+
+interface SelectionRange {
+    startCol: number;
+    startRow: number;
+    endCol: number;
+    endRow: number;
+}
+declare class SelectionManager {
+    private _startCol;
+    private _startRow;
+    private _endCol;
+    private _endRow;
+    private _active;
+    private _selecting;
+    startSelection(col: number, row: number): void;
+    updateSelection(col: number, row: number): void;
+    endSelection(): void;
+    clearSelection(): void;
+    get active(): boolean;
+    get selecting(): boolean;
+    /** Returns the selection range normalized to reading order (top-left to bottom-right) */
+    getSelectedRange(): SelectionRange | null;
+    isSelected(col: number, row: number): boolean;
+    getSelectedText(buffer: BrowserBuffer): string;
+}
+
+interface CanvasPainterOptions {
+    fontFamily?: string;
+    fontSize?: number;
+}
+declare class CanvasPainter {
+    private cellWidth;
+    private cellHeight;
+    private fontFamily;
+    private fontSize;
+    private baselineOffset;
+    constructor(options?: CanvasPainterOptions);
+    measureCell(ctx: CanvasRenderingContext2D): {
+        width: number;
+        height: number;
+    };
+    getCellSize(): {
+        width: number;
+        height: number;
+    };
+    paint(ctx: CanvasRenderingContext2D, buffer: BrowserBuffer, selection?: SelectionManager): void;
+}
+
+declare class BrowserRenderer {
+    canvas: HTMLCanvasElement;
+    ctx2d: CanvasRenderingContext2D;
+    buffer: BrowserBuffer;
+    renderContext: BrowserRenderContext;
+    root: any;
+    painter: CanvasPainter;
+    selection: SelectionManager;
+    private cols;
+    private rows;
+    private cellWidth;
+    private cellHeight;
+    private rafId;
+    private lastTime;
+    private needsRender;
+    private isDragOver;
+    private cleanupListeners;
+    private mouseDownCell;
+    constructor(canvas: HTMLCanvasElement, cols: number, rows: number);
+    private pixelToCell;
+    private setupDomListeners;
+    start(): void;
+    stop(): void;
+    private loop;
+    resize(cols: number, rows: number): void;
+    private static PREVENT_DEFAULT_KEYS;
+    private static MODIFIER_KEYS;
+    private static KEY_MAP;
+    handleKeyDown(event: KeyboardEvent): void;
+}
+
+interface TUIProps {
+    children: ReactNode;
+    /** CSS styles for the outer container div */
+    style?: CSSProperties;
+    /** CSS class for the outer container div */
+    className?: string;
+    /** Font size in pixels (default: 14) */
+    fontSize?: number;
+    /** Font family (default: monospace stack) */
+    fontFamily?: string;
+    /** Auto-focus the canvas for keyboard input (default: true) */
+    autoFocus?: boolean;
+    /** Called when the renderer is ready */
+    onReady?: (renderer: BrowserRenderer) => void;
+}
+/**
+ * A single React component that renders TUI content to an HTML5 Canvas.
+ * Gridland is built on the opentui engine.
+ *
+ * Usage:
+ * ```tsx
+ * <TUI style={{ width: "100%", height: 400 }}>
+ *   <box border borderStyle="rounded">
+ *     <text>Hello from Gridland!</text>
+ *   </box>
+ * </TUI>
+ * ```
+ *
+ * No dynamic imports, no wrapper chains. Just a component.
+ */
+declare function TUI({ children, style, className, fontSize, fontFamily, autoFocus, onReady, }: TUIProps): react_jsx_runtime.JSX.Element;
+
+interface MountOptions {
+    /** Number of columns (auto-calculated from canvas size if omitted) */
+    cols?: number;
+    /** Number of rows (auto-calculated from canvas size if omitted) */
+    rows?: number;
+    /** Font size in pixels (default: 14) */
+    fontSize?: number;
+    /** Font family (default: monospace stack) */
+    fontFamily?: string;
+    /** Listen for keyboard events on the canvas (default: true) */
+    keyboard?: boolean;
+    /** Auto-resize when canvas size changes (default: true) */
+    autoResize?: boolean;
+}
+interface MountResult {
+    renderer: BrowserRenderer;
+    unmount: () => void;
+    resize: (cols: number, rows: number) => void;
+}
+/**
+ * Imperative API to mount Gridland content into a canvas element.
+ *
+ * ```ts
+ * const canvas = document.getElementById("my-canvas") as HTMLCanvasElement
+ * const { unmount } = mountGridland(canvas, <App />)
+ * ```
+ */
+declare function mountGridland(canvas: HTMLCanvasElement, element: ReactNode, options?: MountOptions): MountResult;
+
+interface TextChunk {
+    __isChunk: true;
+    text: string;
+    fg?: RGBA;
+    bg?: RGBA;
+    attributes?: number;
+    link?: {
+        url: string;
+    };
+}
+interface StyledTextInput {
+    chunks: TextChunk[];
+}
+declare class BrowserTextBuffer {
+    private _text;
+    private _chunks;
+    private _defaultFg;
+    private _defaultBg;
+    private _defaultAttributes;
+    private _syntaxStyle;
+    private _tabWidth;
+    private _widthMethod;
+    constructor(widthMethod: WidthMethod);
+    static create(widthMethod: WidthMethod): BrowserTextBuffer;
+    get ptr(): number;
+    get length(): number;
+    get byteSize(): number;
+    setText(text: string): void;
+    append(text: string): void;
+    setStyledText(styledText: StyledTextInput): void;
+    getPlainText(): string;
+    getTextRange(startOffset: number, endOffset: number): string;
+    getLineCount(): number;
+    getChunks(): TextChunk[];
+    setDefaultFg(fg: RGBA | null): void;
+    setDefaultBg(bg: RGBA | null): void;
+    setDefaultAttributes(attributes: number | null): void;
+    resetDefaults(): void;
+    get defaultFg(): RGBA | null;
+    get defaultBg(): RGBA | null;
+    get defaultAttributes(): number;
+    setSyntaxStyle(style: any): void;
+    getSyntaxStyle(): any;
+    setTabWidth(width: number): void;
+    getTabWidth(): number;
+    addHighlightByCharRange(_highlight: any): void;
+    addHighlight(_lineIdx: number, _highlight: any): void;
+    removeHighlightsByRef(_hlRef: number): void;
+    clearLineHighlights(_lineIdx: number): void;
+    clearAllHighlights(): void;
+    getLineHighlights(_lineIdx: number): any[];
+    getHighlightCount(): number;
+    loadFile(_path: string): void;
+    clear(): void;
+    reset(): void;
+    destroy(): void;
+}
+
+interface VisibleLineChunk {
+    text: string;
+    fg: RGBA;
+    bg: RGBA;
+    attributes: number;
+    link?: {
+        url: string;
+    };
+}
+interface VisibleLine {
+    chunks: VisibleLineChunk[];
+}
+declare class BrowserTextBufferView {
+    private textBuffer;
+    private _wrapWidth;
+    private _wrapMode;
+    private _viewportX;
+    private _viewportY;
+    private _viewportWidth;
+    private _viewportHeight;
+    private _truncate;
+    private _selection;
+    private _selectionBg;
+    private _selectionFg;
+    constructor(textBuffer: BrowserTextBuffer);
+    static create(textBuffer: BrowserTextBuffer): BrowserTextBufferView;
+    get ptr(): number;
+    get lineInfo(): {
+        lineStarts: number[];
+        lineWidths: number[];
+        maxLineWidth: number;
+        lineSources: number[];
+        lineWraps: number[];
+    };
+    get logicalLineInfo(): {
+        lineStarts: number[];
+        lineWidths: number[];
+        maxLineWidth: number;
+        lineSources: number[];
+        lineWraps: number[];
+    };
+    setSelection(start: number, end: number, bgColor?: RGBA, fgColor?: RGBA): void;
+    updateSelection(end: number, bgColor?: RGBA, fgColor?: RGBA): void;
+    resetSelection(): void;
+    getSelection(): {
+        start: number;
+        end: number;
+    } | null;
+    hasSelection(): boolean;
+    setLocalSelection(_anchorX: number, _anchorY: number, _focusX: number, _focusY: number, _bgColor?: RGBA, _fgColor?: RGBA): boolean;
+    updateLocalSelection(_anchorX: number, _anchorY: number, _focusX: number, _focusY: number, _bgColor?: RGBA, _fgColor?: RGBA): boolean;
+    resetLocalSelection(): void;
+    getSelectedText(): string;
+    getPlainText(): string;
+    setWrapWidth(width: number | null): void;
+    setWrapMode(mode: "none" | "char" | "word"): void;
+    setViewportSize(width: number, height: number): void;
+    setViewport(x: number, y: number, width: number, height: number): void;
+    setTabIndicator(_indicator: string | number): void;
+    setTabIndicatorColor(_color: RGBA): void;
+    setTruncate(truncate: boolean): void;
+    private getAllWrappedLines;
+    private sliceChunks;
+    measureForDimensions(width: number, height: number): {
+        lineCount: number;
+        maxWidth: number;
+    } | null;
+    getVirtualLineCount(): number;
+    getVisibleLines(): VisibleLine[] | null;
+    destroy(): void;
+}
+
+declare class BrowserSyntaxStyle {
+    private _destroyed;
+    static create(): BrowserSyntaxStyle;
+    static fromTheme(_theme: any): BrowserSyntaxStyle;
+    static fromStyles(_styles: any): BrowserSyntaxStyle;
+    get ptr(): number;
+    registerStyle(_name: string, _style: any): number;
+    resolveStyleId(_name: string): number | null;
+    getStyleId(_name: string): number | null;
+    getStyleCount(): number;
+    clearNameCache(): void;
+    getStyle(_name: string): any;
+    mergeStyles(..._styleNames: string[]): {
+        attributes: number;
+    };
+    clearCache(): void;
+    getCacheSize(): number;
+    getAllStyles(): Map<string, any>;
+    getRegisteredNames(): string[];
+    destroy(): void;
+}
+
+interface BrowserRoot {
+    render(node: ReactNode): void;
+    unmount(): void;
+}
+declare function createBrowserRoot(renderer: BrowserRenderer): BrowserRoot;
+
+interface DroppedFile {
+    name: string;
+    content: string;
+    type: string;
+    size: number;
+}
+declare function useFileDrop(callback: (file: DroppedFile) => void): {
+    isDragOver: boolean;
+};
+
+declare function usePaste(callback: (text: string) => void): void;
+
+interface BrowserContextValue {
+    renderContext: BrowserRenderContext;
+}
+declare const BrowserContext: react.Context<BrowserContextValue | null>;
+declare function useBrowserContext(): BrowserContextValue;
+
+/**
+ * SSR-safe utilities for @gridland/web.
+ * These can be imported in any environment (Node.js, browser, edge).
+ */
+/** Check if running in a browser environment */
+declare function isBrowser(): boolean;
+/** Check if canvas is supported */
+declare function isCanvasSupported(): boolean;
+/** Calculate grid dimensions from pixel dimensions and font size */
+declare function calculateGridSize(widthPx: number, heightPx: number, cellWidth: number, cellHeight: number): {
+    cols: number;
+    rows: number;
+};
+
+export { type BorderDrawOptions, BrowserBuffer, BrowserContext, type BrowserContextValue, BrowserRenderContext, BrowserRenderer, type BrowserRoot, BrowserSyntaxStyle, BrowserTextBuffer, BrowserTextBufferView, CanvasPainter, type CanvasPainterOptions, type DroppedFile, type MountOptions, type MountResult, SelectionManager, type StyledTextInput, TUI, type TUIProps, type TextChunk, type VisibleLine, type VisibleLineChunk, type WidthMethod, calculateGridSize, createBrowserRoot, isBrowser, isCanvasSupported, mountGridland, useBrowserContext, useFileDrop, usePaste };