@aurigax-ai/ghostty-web 0.0.0-stage → 0.1.0

package/lib/index.ts

@@ -0,0 +1,110 @@
+/**
+ * Public API for @cmux/ghostty-terminal
+ *
+ * Main entry point following xterm.js conventions
+ */
+
+import { Ghostty } from './ghostty';
+
+// Module-level Ghostty instance (initialized by init())
+let ghosttyInstance: Ghostty | null = null;
+
+/**
+ * Initialize the ghostty-web library by loading the WASM module.
+ * Must be called before creating any Terminal instances.
+ *
+ * This creates a shared WASM instance that all Terminal instances will use.
+ * For test isolation, pass a Ghostty instance directly to Terminal constructor.
+ *
+ * @example
+ * ```typescript
+ * import { init, Terminal } from 'ghostty-web';
+ *
+ * await init();
+ * const term = new Terminal();
+ * term.open(document.getElementById('terminal'));
+ * ```
+ */
+export async function init(): Promise<void> {
+  if (ghosttyInstance) {
+    return; // Already initialized
+  }
+  ghosttyInstance = await Ghostty.load();
+}
+
+/**
+ * Get the initialized Ghostty instance.
+ * Throws if init() hasn't been called.
+ * @internal
+ */
+export function getGhostty(): Ghostty {
+  if (!ghosttyInstance) {
+    throw new Error(
+      'ghostty-web not initialized. Call init() before creating Terminal instances.\n' +
+        'Example:\n' +
+        '  import { init, Terminal } from "@aurigax-ai/ghostty-web";\n' +
+        '  await init();\n' +
+        '  const term = new Terminal();\n\n' +
+        'For tests, pass a Ghostty instance directly:\n' +
+        '  import { Ghostty, Terminal } from "@aurigax-ai/ghostty-web";\n' +
+        '  const ghostty = await Ghostty.load();\n' +
+        '  const term = new Terminal({ ghostty });'
+    );
+  }
+  return ghosttyInstance;
+}
+
+// Main Terminal class
+export { Terminal } from './terminal';
+
+// xterm.js-compatible interfaces
+export type {
+  ITerminalOptions,
+  ITheme,
+  ITerminalAddon,
+  ITerminalCore,
+  IDisposable,
+  IEvent,
+  IBufferRange,
+  IKeyEvent,
+  IUnicodeVersionProvider,
+} from './interfaces';
+
+// Ghostty WASM components (for advanced usage)
+export {
+  Ghostty,
+  GhosttyTerminal,
+  KeyEncoder,
+  CellFlags,
+  DirtyState,
+  KeyEncoderOption,
+} from './ghostty';
+export type {
+  DesktopNotificationEvent,
+  MouseTrackingMode,
+  SemanticPromptEvent,
+  SemanticPromptKind,
+  TrackedRow,
+} from './ghostty';
+export type { IMarker } from './marker';
+export { Abi, GhosttyCallError } from './abi';
+export { Key, KeyAction, Mods } from './types';
+export type { KeyEvent, GhosttyCell, RGB, Cursor, TerminalHandle } from './types';
+
+// Low-level components (for custom integrations)
+export { CanvasRenderer } from './renderer';
+export type { RendererOptions, FontMetrics, IRenderable } from './renderer';
+export { InputHandler } from './input-handler';
+export { EventEmitter } from './event-emitter';
+export { SelectionManager } from './selection-manager';
+export type { SelectionCoordinates } from './selection-manager';
+
+// Addons
+export { FitAddon } from './addons/fit';
+export type { ITerminalDimensions } from './addons/fit';
+
+// Link providers
+export { OSC8LinkProvider } from './providers/osc8-link-provider';
+export { UrlRegexProvider } from './providers/url-regex-provider';
+export { LinkDetector } from './link-detector';
+export type { ILink, ILinkProvider, IBufferCellPosition } from './types';