restty 0.1.23 → 0.1.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "restty",
-  "version": "0.1.23",
+  "version": "0.1.25",
   "description": "Browser terminal rendering library powered by WASM, WebGPU/WebGL2, and TypeScript text shaping.",
   "keywords": [
     "terminal",

package/dist/app/index.d.ts

@@ -1,9 +0,0 @@
-import type { ResttyApp, ResttyAppOptions } from "./types";
-export { createResttyAppSession, getDefaultResttyAppSession } from "./session";
-export { createResttyPaneManager, createDefaultResttyPaneContextMenuItems, getResttyShortcutModifierLabel, } from "./panes";
-export { Restty } from "./restty";
-export { RESTTY_PLUGIN_API_VERSION } from "./restty";
-export type { ResttyAppElements, ResttyAppCallbacks, FontSource, ResttyFontSource, ResttyTouchSelectionMode, ResttyUrlFontSource, ResttyBufferFontSource, ResttyLocalFontSource, ResttyWasmLogListener, ResttyAppSession, ResttyAppInputPayload, ResttyAppOptions, ResttyApp, } from "./types";
-export type { ResttyPaneSplitDirection, ResttyPaneContextMenuItem, ResttyPaneDefinition, ResttyPaneStyleOptions, ResttyPaneStylesOptions, ResttyPaneShortcutsOptions, ResttyPaneContextMenuOptions, CreateResttyPaneManagerOptions, ResttyPaneManager, ResttyPaneWithApp, CreateDefaultResttyPaneContextMenuItemsOptions, } from "./panes";
-export type { ResttyOptions, ResttyPluginApiRange, ResttyPlugin, ResttyPluginCleanup, ResttyPluginContext, ResttyPluginDisposable, ResttyPluginEvents, ResttyPluginInfo, ResttyPluginRequires, ResttyInputInterceptor, ResttyInputInterceptorPayload, ResttyInterceptorOptions, ResttyLifecycleHook, ResttyLifecycleHookPayload, ResttyPluginLoadResult, ResttyPluginLoadStatus, ResttyPluginManifestEntry, ResttyPluginRegistry, ResttyPluginRegistryEntry, ResttyRenderHook, ResttyRenderHookPayload, ResttyOutputInterceptor, ResttyOutputInterceptorPayload, } from "./restty";
-export declare function createResttyApp(options: ResttyAppOptions): ResttyApp;

package/dist/app/panes.d.ts

@@ -1,15 +0,0 @@
-import type { CreateDefaultResttyPaneContextMenuItemsOptions, CreateResttyPaneManagerOptions, ResttyPaneContextMenuItem, ResttyPaneDefinition, ResttyPaneManager, ResttyPaneWithApp } from "./panes-types";
-export type { CreateDefaultResttyPaneContextMenuItemsOptions, CreateResttyPaneManagerOptions, ResttyPaneContextMenuItem, ResttyPaneContextMenuOptions, ResttyPaneDefinition, ResttyPaneManager, ResttyPaneShortcutsOptions, ResttyPaneSplitDirection, ResttyPaneStyleOptions, ResttyPaneStylesOptions, ResttyPaneWithApp, } from "./panes-types";
-/** Return the platform-appropriate shortcut modifier label ("Cmd" on macOS, "Ctrl" elsewhere). */
-export declare function getResttyShortcutModifierLabel(): "Cmd" | "Ctrl";
-/**
- * Build the standard right-click context menu items for a pane
- * (copy, paste, split, close, clear, PTY toggle, pause toggle).
- */
-export declare function createDefaultResttyPaneContextMenuItems<TPane extends ResttyPaneWithApp>(options: CreateDefaultResttyPaneContextMenuItemsOptions<TPane>): Array<ResttyPaneContextMenuItem | "separator">;
-/**
- * Create a pane manager that owns a split-pane layout inside a root
- * element. Handles pane creation, splitting, resizing, focus
- * tracking, keyboard shortcuts, and context menus.
- */
-export declare function createResttyPaneManager<TPane extends ResttyPaneDefinition>(options: CreateResttyPaneManagerOptions<TPane>): ResttyPaneManager<TPane>;

package/dist/app/restty.d.ts

@@ -1,336 +0,0 @@
-import type { InputHandler, MouseMode } from "../input";
-import type { GhosttyTheme } from "../theme";
-import { type CreateResttyAppPaneManagerOptions, type ResttyManagedAppPane, type ResttyManagedPaneStyleOptions, type ResttyPaneAppOptionsInput } from "./pane-app-manager";
-import type { ResttyPaneManager, ResttyPaneSplitDirection } from "./panes";
-import type { ResttyFontSource } from "./types";
-/**
- * Top-level configuration for creating a Restty instance.
- */
-export type ResttyOptions = Omit<CreateResttyAppPaneManagerOptions, "appOptions"> & {
-    /** Per-pane app options, static or factory. */
-    appOptions?: CreateResttyAppPaneManagerOptions["appOptions"];
-    /** Font sources applied to every pane. */
-    fontSources?: ResttyPaneAppOptionsInput["fontSources"];
-    /** Whether to create the first pane automatically (default true). */
-    createInitialPane?: boolean | {
-        focus?: boolean;
-    };
-};
-/** Current Restty plugin API version. */
-export declare const RESTTY_PLUGIN_API_VERSION = 1;
-/** Plugin API version requirements. */
-export type ResttyPluginApiRange = {
-    min: number;
-    max?: number;
-};
-/** Optional compatibility requirements declared by plugins. */
-export type ResttyPluginRequires = {
-    pluginApi?: number | ResttyPluginApiRange;
-};
-/** Diagnostics snapshot for a plugin. */
-export type ResttyPluginInfo = {
-    id: string;
-    version: string | null;
-    apiVersion: number | null;
-    requires: ResttyPluginRequires | null;
-    active: boolean;
-    activatedAt: number | null;
-    lastError: string | null;
-    listeners: number;
-    inputInterceptors: number;
-    outputInterceptors: number;
-    lifecycleHooks: number;
-    renderHooks: number;
-};
-/** Declarative plugin manifest entry for registry-based loading. */
-export type ResttyPluginManifestEntry = {
-    id: string;
-    enabled?: boolean;
-    options?: unknown;
-};
-/** Provider entry for plugin registry lookups. */
-export type ResttyPluginRegistryEntry = ResttyPlugin | (() => ResttyPlugin | Promise<ResttyPlugin>);
-/** Registry shape accepted by loadPlugins. */
-export type ResttyPluginRegistry = ReadonlyMap<string, ResttyPluginRegistryEntry> | Record<string, ResttyPluginRegistryEntry>;
-/** Status for manifest-driven plugin load attempts. */
-export type ResttyPluginLoadStatus = "loaded" | "skipped" | "missing" | "failed";
-/** Result row returned by loadPlugins. */
-export type ResttyPluginLoadResult = {
-    id: string;
-    status: ResttyPluginLoadStatus;
-    error: string | null;
-};
-/** Event payloads emitted by the Restty plugin host. */
-export type ResttyPluginEvents = {
-    "plugin:activated": {
-        pluginId: string;
-    };
-    "plugin:deactivated": {
-        pluginId: string;
-    };
-    "pane:created": {
-        paneId: number;
-    };
-    "pane:closed": {
-        paneId: number;
-    };
-    "pane:split": {
-        sourcePaneId: number;
-        createdPaneId: number;
-        direction: ResttyPaneSplitDirection;
-    };
-    "pane:active-changed": {
-        paneId: number | null;
-    };
-    "layout:changed": {};
-    "pane:resized": {
-        paneId: number;
-        cols: number;
-        rows: number;
-    };
-    "pane:focused": {
-        paneId: number;
-    };
-    "pane:blurred": {
-        paneId: number;
-    };
-};
-/** A disposable resource returned by plugin APIs. */
-export type ResttyPluginDisposable = {
-    dispose: () => void;
-};
-/** Optional cleanup return supported by plugin activation. */
-export type ResttyPluginCleanup = void | (() => void) | ResttyPluginDisposable;
-/** Payload passed to input interceptors before terminal/program input is written. */
-export type ResttyInputInterceptorPayload = {
-    paneId: number;
-    text: string;
-    source: string;
-};
-/** Payload passed to output interceptors before PTY data is rendered. */
-export type ResttyOutputInterceptorPayload = {
-    paneId: number;
-    text: string;
-    source: string;
-};
-/** Input interceptor contract. */
-export type ResttyInputInterceptor = (payload: ResttyInputInterceptorPayload) => string | null | void;
-/** Output interceptor contract. */
-export type ResttyOutputInterceptor = (payload: ResttyOutputInterceptorPayload) => string | null | void;
-/** Payload passed to lifecycle hooks registered by plugins. */
-export type ResttyLifecycleHookPayload = {
-    phase: "before" | "after";
-    action: "create-initial-pane" | "split-active-pane" | "split-pane" | "close-pane" | "set-active-pane" | "mark-pane-focused" | "connect-pty" | "disconnect-pty" | "resize" | "focus" | "blur";
-    paneId?: number | null;
-    sourcePaneId?: number;
-    createdPaneId?: number | null;
-    direction?: ResttyPaneSplitDirection;
-    cols?: number;
-    rows?: number;
-    ok?: boolean;
-    error?: string | null;
-};
-/** Lifecycle hook contract. */
-export type ResttyLifecycleHook = (payload: ResttyLifecycleHookPayload) => void;
-/** Payload passed to render hooks registered by plugins. */
-export type ResttyRenderHookPayload = {
-    phase: "before" | "after";
-    paneId: number;
-    text: string;
-    source: string;
-    dropped: boolean;
-};
-/** Render hook contract. */
-export type ResttyRenderHook = (payload: ResttyRenderHookPayload) => void;
-/** Shared options for interceptor ordering. */
-export type ResttyInterceptorOptions = {
-    priority?: number;
-};
-/** Context object provided to each plugin on activation. */
-export type ResttyPluginContext = {
-    restty: Restty;
-    options: unknown;
-    panes: () => ResttyPaneHandle[];
-    pane: (id: number) => ResttyPaneHandle | null;
-    activePane: () => ResttyPaneHandle | null;
-    focusedPane: () => ResttyPaneHandle | null;
-    on: <E extends keyof ResttyPluginEvents>(event: E, listener: (payload: ResttyPluginEvents[E]) => void) => ResttyPluginDisposable;
-    addInputInterceptor: (interceptor: ResttyInputInterceptor, options?: ResttyInterceptorOptions) => ResttyPluginDisposable;
-    addOutputInterceptor: (interceptor: ResttyOutputInterceptor, options?: ResttyInterceptorOptions) => ResttyPluginDisposable;
-    addLifecycleHook: (hook: ResttyLifecycleHook, options?: ResttyInterceptorOptions) => ResttyPluginDisposable;
-    addRenderHook: (hook: ResttyRenderHook, options?: ResttyInterceptorOptions) => ResttyPluginDisposable;
-};
-/** Plugin contract for extending Restty behavior. */
-export type ResttyPlugin = {
-    id: string;
-    version?: string;
-    apiVersion?: number;
-    requires?: ResttyPluginRequires;
-    activate: (context: ResttyPluginContext, options?: unknown) => ResttyPluginCleanup | Promise<ResttyPluginCleanup>;
-};
-/**
- * Public API surface exposed by each pane handle.
- */
-export type ResttyPaneApi = {
-    id: number;
-    setRenderer: (value: "auto" | "webgpu" | "webgl2") => void;
-    setPaused: (value: boolean) => void;
-    togglePause: () => void;
-    setFontSize: (value: number) => void;
-    applyTheme: (theme: GhosttyTheme, sourceLabel?: string) => void;
-    resetTheme: () => void;
-    sendInput: (text: string, source?: string) => void;
-    sendKeyInput: (text: string, source?: string) => void;
-    clearScreen: () => void;
-    connectPty: (url?: string) => void;
-    disconnectPty: () => void;
-    isPtyConnected: () => boolean;
-    setMouseMode: (value: MouseMode) => void;
-    getMouseStatus: () => ReturnType<InputHandler["getMouseStatus"]>;
-    copySelectionToClipboard: () => Promise<boolean>;
-    pasteFromClipboard: () => Promise<boolean>;
-    dumpAtlasForCodepoint: (cp: number) => void;
-    resize: (cols: number, rows: number) => void;
-    focus: () => void;
-    blur: () => void;
-    updateSize: (force?: boolean) => void;
-    getBackend: () => string;
-    getRawPane: () => ResttyManagedAppPane;
-};
-/**
- * Thin wrapper around a managed pane that delegates calls to the
- * underlying app. Resolves the pane lazily so it stays valid across
- * layout changes.
- */
-export declare class ResttyPaneHandle implements ResttyPaneApi {
-    private readonly resolvePane;
-    constructor(resolvePane: () => ResttyManagedAppPane);
-    get id(): number;
-    setRenderer(value: "auto" | "webgpu" | "webgl2"): void;
-    setPaused(value: boolean): void;
-    togglePause(): void;
-    setFontSize(value: number): void;
-    applyTheme(theme: GhosttyTheme, sourceLabel?: string): void;
-    resetTheme(): void;
-    sendInput(text: string, source?: string): void;
-    sendKeyInput(text: string, source?: string): void;
-    clearScreen(): void;
-    connectPty(url?: string): void;
-    disconnectPty(): void;
-    isPtyConnected(): boolean;
-    setMouseMode(value: MouseMode): void;
-    getMouseStatus(): ReturnType<InputHandler["getMouseStatus"]>;
-    copySelectionToClipboard(): Promise<boolean>;
-    pasteFromClipboard(): Promise<boolean>;
-    dumpAtlasForCodepoint(cp: number): void;
-    resize(cols: number, rows: number): void;
-    focus(): void;
-    blur(): void;
-    updateSize(force?: boolean): void;
-    getBackend(): string;
-    getRawPane(): ResttyManagedAppPane;
-}
-/**
- * Main entry point for the restty terminal widget. Manages a set of
- * split panes, each running its own terminal app, and exposes
- * convenience methods that operate on the active pane.
- */
-export declare class Restty {
-    readonly paneManager: ResttyPaneManager<ResttyManagedAppPane>;
-    private fontSources;
-    private readonly pluginListeners;
-    private readonly pluginRuntimes;
-    private readonly pluginDiagnostics;
-    private readonly inputInterceptors;
-    private readonly outputInterceptors;
-    private readonly lifecycleHooks;
-    private readonly renderHooks;
-    private nextInterceptorId;
-    private nextInterceptorOrder;
-    constructor(options: ResttyOptions);
-    getPanes(): ResttyManagedAppPane[];
-    getPaneById(id: number): ResttyManagedAppPane | null;
-    getActivePane(): ResttyManagedAppPane | null;
-    getFocusedPane(): ResttyManagedAppPane | null;
-    panes(): ResttyPaneHandle[];
-    pane(id: number): ResttyPaneHandle | null;
-    activePane(): ResttyPaneHandle | null;
-    focusedPane(): ResttyPaneHandle | null;
-    forEachPane(visitor: (pane: ResttyPaneHandle) => void): void;
-    setFontSources(sources: ResttyFontSource[]): Promise<void>;
-    createInitialPane(options?: {
-        focus?: boolean;
-    }): ResttyManagedAppPane;
-    splitActivePane(direction: ResttyPaneSplitDirection): ResttyManagedAppPane | null;
-    splitPane(id: number, direction: ResttyPaneSplitDirection): ResttyManagedAppPane | null;
-    closePane(id: number): boolean;
-    getPaneStyleOptions(): Readonly<Required<ResttyManagedPaneStyleOptions>>;
-    setPaneStyleOptions(options: ResttyManagedPaneStyleOptions): void;
-    setActivePane(id: number, options?: {
-        focus?: boolean;
-    }): void;
-    markPaneFocused(id: number, options?: {
-        focus?: boolean;
-    }): void;
-    requestLayoutSync(): void;
-    hideContextMenu(): void;
-    use(plugin: ResttyPlugin, options?: unknown): Promise<void>;
-    loadPlugins(manifest: ReadonlyArray<ResttyPluginManifestEntry>, registry: ResttyPluginRegistry): Promise<ResttyPluginLoadResult[]>;
-    unuse(pluginId: string): boolean;
-    plugins(): string[];
-    pluginInfo(pluginId: string): ResttyPluginInfo | null;
-    pluginInfo(): ResttyPluginInfo[];
-    destroy(): void;
-    connectPty(url?: string): void;
-    disconnectPty(): void;
-    isPtyConnected(): boolean;
-    setRenderer(value: "auto" | "webgpu" | "webgl2"): void;
-    setPaused(value: boolean): void;
-    togglePause(): void;
-    setFontSize(value: number): void;
-    applyTheme(theme: GhosttyTheme, sourceLabel?: string): void;
-    resetTheme(): void;
-    sendInput(text: string, source?: string): void;
-    sendKeyInput(text: string, source?: string): void;
-    clearScreen(): void;
-    setMouseMode(value: MouseMode): void;
-    getMouseStatus(): ReturnType<InputHandler["getMouseStatus"]>;
-    copySelectionToClipboard(): Promise<boolean>;
-    pasteFromClipboard(): Promise<boolean>;
-    dumpAtlasForCodepoint(cp: number): void;
-    resize(cols: number, rows: number): void;
-    focus(): void;
-    blur(): void;
-    updateSize(force?: boolean): void;
-    getBackend(): string;
-    private makePaneHandle;
-    private requirePaneById;
-    private requireActivePaneHandle;
-    private createPluginContext;
-    private attachRuntimeDisposer;
-    private addInputInterceptor;
-    private addOutputInterceptor;
-    private addLifecycleHook;
-    private addRenderHook;
-    private registerInterceptor;
-    private applyInputInterceptors;
-    private applyOutputInterceptors;
-    private runLifecycleHooks;
-    private runRenderHooks;
-    private applyInterceptors;
-    private runHooks;
-    private normalizePluginMetadata;
-    private assertPluginCompatibility;
-    private lookupPluginRegistryEntry;
-    private resolvePluginRegistryEntry;
-    private setPluginLoadError;
-    private updatePluginDiagnostic;
-    private buildPluginInfo;
-    private errorToMessage;
-    private onPluginEvent;
-    private emitPluginEvent;
-    private teardownPluginRuntime;
-    private normalizePluginCleanup;
-}
-/** Create a new Restty instance with the given options. */
-export declare function createRestty(options: ResttyOptions): Restty;

package/dist/fonts/manager.d.ts

@@ -1,45 +0,0 @@
-import type { FontEntry, FontManagerState, ShapedCluster, FallbackFontSource, FontScaleOverride } from "./types";
-/** Check whether a font entry is a symbol/icon font based on its label. */
-export declare function isSymbolFont(entry: FontEntry | null | undefined): boolean;
-/** Check whether a font entry is a Nerd Font symbols font. */
-export declare function isNerdSymbolFont(entry: FontEntry | null | undefined): boolean;
-/** Check whether a font entry is a color emoji font. */
-export declare function isColorEmojiFont(entry: FontEntry | null | undefined): boolean;
-/** Return the maximum cell span for a font (2 for CJK/emoji, 1 otherwise). */
-export declare function fontMaxCellSpan(entry: FontEntry | null | undefined): number;
-/** Return the scale multiplier for a font entry by matching its label against overrides. */
-export declare function fontScaleOverride(entry: FontEntry | null | undefined, overrides?: FontScaleOverride[]): number;
-/** Compute the atlas raster scale for a font, applying symbol atlas scaling for fallback symbol fonts. */
-export declare function fontRasterScale(entry: FontEntry | null | undefined, fontIndex: number, maxSymbolAtlasScale: number, overrides?: FontScaleOverride[]): number;
-/** Create a new FontEntry with empty caches and default metadata. */
-export declare function createFontEntry(font: any, label: string): FontEntry;
-/** Clear all caches and reset rendering metadata on a font entry. */
-export declare function resetFontEntry(entry: FontEntry): void;
-/** Create an empty FontManagerState for initialization. */
-export declare function createFontManagerState(): FontManagerState;
-/** Check whether a font has a non-zero glyph ID for the given character. */
-export declare function fontHasGlyph(font: any, ch: string): boolean;
-/** Get the horizontal advance width in font design units, computing and caching it if needed. */
-export declare function fontAdvanceUnits(entry: FontEntry, shapeClusterWithFont: (entry: FontEntry, text: string) => ShapedCluster): number;
-/** Get the bounding-box width of a glyph in font design units, with caching. */
-export declare function glyphWidthUnits(entry: FontEntry, glyphId: number | undefined | null): number;
-/**
- * Select the best font index from the manager's font list for rendering the
- * given text cluster, searching in fallback order similar to Ghostty.
- */
-export declare function pickFontIndexForText(state: FontManagerState, text: string, expectedSpan: number): number;
-/** Fetch a font file from a URL and return its ArrayBuffer, or null on failure. */
-export declare function tryFetchFontBuffer(url: string): Promise<ArrayBuffer | null>;
-/** Query locally installed fonts via the Local Font Access API and return the first match, or null. */
-export declare function tryLocalFontBuffer(matchers: string[]): Promise<ArrayBuffer | null>;
-/**
- * Load the primary font buffer, trying local Nerd Font matchers first,
- * then a remote fallback URL, then broader local font matchers. Throws
- * if all sources fail.
- */
-export declare function loadPrimaryFontBuffer(localMatchers: string[], fallbackUrl: string, fallbackLocalMatchers: string[]): Promise<ArrayBuffer>;
-/** Load fallback font buffers from a list of sources, trying remote URLs then local matchers. */
-export declare function loadFallbackFontBuffers(sources: FallbackFontSource[]): Promise<{
-    name: string;
-    buffer: ArrayBuffer;
-}[]>;

package/dist/renderer/webgpu.d.ts

@@ -1,33 +0,0 @@
-import type { WebGPUCoreState, WebGPUState, WebGLState } from "./types";
-/** Initialize shared WebGPU core state (device, pipelines, vertex buffer) from a canvas. */
-export declare function initWebGPUCore(canvas: HTMLCanvasElement): Promise<WebGPUCoreState | null>;
-/**
- * Initialize a full WebGPU renderer state for a canvas, including context,
- * uniform buffer, and bind groups. Accepts an optional pre-initialized core.
- */
-export declare function initWebGPU(canvas: HTMLCanvasElement, options?: {
-    core?: WebGPUCoreState | null;
-}): Promise<WebGPUState | null>;
-/** Initialize a WebGL2 fallback renderer state from a canvas. */
-export declare function initWebGL(canvas: HTMLCanvasElement): WebGLState | null;
-/** Grow a WebGPU instance buffer if the required byte length exceeds current capacity. */
-export declare function ensureInstanceBuffer(state: WebGPUState, kind: "rect" | "glyph", byteLength: number): void;
-/** Re-configure the WebGPU canvas context with the current device and format. */
-export declare function configureContext(state: WebGPUState): void;
-/** Grow a WebGL instance buffer if the required byte length exceeds current capacity. */
-export declare function ensureGLInstanceBuffer(state: WebGLState, kind: "rect" | "glyph", byteLength: number): void;
-/** Create the initial resize tracking state with default values. */
-export declare function createResizeState(): {
-    active: boolean;
-    lastAt: number;
-    cols: number;
-    rows: number;
-    dpr: number;
-};
-/** Create the initial scrollbar position state with default values. */
-export declare function createScrollbarState(): {
-    lastInputAt: number;
-    lastTotal: number;
-    lastOffset: number;
-    lastLen: number;
-};

package/dist/restty-input.d.ts

@@ -1 +0,0 @@
-export * from "./input/index";