@aitty/browser 0.1.0

package/dist/frontend/terminal-app.d.ts

@@ -0,0 +1,156 @@
+import { BrowserTerminalBridge, BrowserTerminalRenderOptions } from "./browser-terminal-renderer.js";
+import { TerminalKeyResolver } from "./terminal-input-policies.js";
+import { WTermOptions } from "@wterm/dom";
+import { AittyRuntimeKind, AittyTerminalConnectionState, AittyTerminalLoadingPresentation, AittyTerminalOutputState, AittyTerminalSessionPresentationState, AittyTerminalStatusSnapshot, AittyTheme } from "@aitty/protocol";
+
+//#region src/frontend/terminal-app.d.ts
+type RuntimeKind = AittyRuntimeKind;
+type TerminalTheme = AittyTheme;
+type TerminalConnectionState = AittyTerminalConnectionState;
+type TerminalOutputState = AittyTerminalOutputState;
+type TerminalSessionPresentationState = AittyTerminalSessionPresentationState;
+type BinaryWriteTarget = {
+  write(data: Uint8Array): void;
+};
+type FrameScheduler = {
+  cancelFrame?: (handle: number) => void;
+  requestFrame?: (callback: FrameRequestCallback) => number;
+};
+type BufferedTerminalWriter = {
+  destroy(): void;
+  discardPending(): void;
+  enqueue(chunk: Uint8Array): void;
+};
+type TerminalLoadingPresentation = AittyTerminalLoadingPresentation;
+type TerminalStatusSnapshot = AittyTerminalStatusSnapshot;
+type TerminalStatusListener = (status: TerminalStatusSnapshot) => void;
+type TerminalScrollMetrics = {
+  atBottom: boolean;
+  atTop: boolean;
+  clientHeight: number;
+  maxScrollTop: number;
+  scrollHeight: number;
+  scrollTop: number;
+  thumbOffsetRatio: number;
+  thumbSizeRatio: number;
+};
+type TerminalScrollOptions = {
+  getViewport?: () => HTMLElement | null | undefined;
+  onMetricsChange?: (metrics: TerminalScrollMetrics) => void;
+  requestUiUpdate?: () => void;
+  viewport?: HTMLElement | null;
+};
+type TerminalScrollAdapterContext = {
+  content: HTMLElement;
+  scrollOptions: TerminalScrollOptions;
+  target: HTMLElement;
+  viewport: HTMLElement;
+};
+type TerminalScrollAdapter = {
+  destroy?: () => void;
+  scrollOptions?: Partial<TerminalScrollOptions>;
+};
+type TerminalScrollAdapterFactory = (context: TerminalScrollAdapterContext) => TerminalScrollAdapter | void;
+type MountTerminalElements = {
+  loading?: HTMLElement | null;
+  shell?: HTMLElement;
+  status?: HTMLElement | null;
+  terminalRoot?: HTMLElement;
+};
+type TransportCloseEvent = {
+  code?: number;
+  reason?: string;
+  wasClean?: boolean;
+};
+type TransportHandlers = {
+  onBinary(data: Uint8Array): void;
+  onClose(event?: TransportCloseEvent): void;
+  onControlMessage(data: string): void;
+  onError(event: Event): void;
+  onOpen(): void;
+};
+type TerminalTransport = {
+  close(): void;
+  connect(url?: string): void;
+  disconnect?(reason?: string): void;
+  send(data: string | Uint8Array): void;
+  sendControl?(data: string): void;
+};
+type MountTerminalDependencies = {
+  createTerm?: (element: HTMLElement, options: WTermOptions) => BrowserWTerm;
+  createTransport?: (handlers: TransportHandlers) => TerminalTransport;
+  elements?: MountTerminalElements;
+  frameScheduler?: FrameScheduler;
+  input?: {
+    resolveKey?: TerminalKeyResolver;
+  };
+  onStatusChange?: TerminalStatusListener;
+  reconnectDelayMs?: number;
+  resolveRuntimeKind?: (doc: Document, shell: HTMLElement) => RuntimeKind | Promise<RuntimeKind>;
+  scroll?: TerminalScrollOptions;
+  src?: string | URL;
+  theme?: TerminalTheme;
+  transcriptArchiveOptions?: {
+    scrollbackLimit?: number;
+  };
+};
+type MountedTerminalApp = {
+  destroy(): void;
+  getStatus(): TerminalStatusSnapshot;
+  getTheme(): string | undefined;
+  setTheme(theme: TerminalTheme | undefined): void;
+  term: BrowserWTerm;
+  transport: TerminalTransport;
+};
+type TerminalRendererLike = {
+  cols?: number;
+  render?(bridge: BrowserTerminalBridge, options?: BrowserTerminalRenderOptions): void;
+  rows?: number;
+  setup?(cols: number, rows: number): void;
+};
+type BrowserWTerm = {
+  _container?: HTMLElement;
+  _measureCharSize?: () => TerminalCellMetrics;
+  bridge?: BrowserTerminalBridge | null;
+  cols: number;
+  destroy(): void;
+  element: HTMLElement;
+  focus(): void;
+  init(): Promise<unknown>;
+  input?: {
+    destroy?: () => void;
+    focus?: () => void;
+    textarea?: HTMLTextAreaElement | null;
+  };
+  renderer?: TerminalRendererLike;
+  resize(cols: number, rows: number): void;
+  rows: number;
+  write?(data: string | Uint8Array): void;
+};
+type TerminalCellMetrics = {
+  charWidth: number;
+  rowHeight: number;
+};
+/**
+ * Batches raw PTY bytes into animation frames without splitting UTF-8 codepoints or
+ * incomplete ANSI sequences. This is the only throttling layer in the browser path.
+ */
+declare function createBufferedTerminalWriter(target: BinaryWriteTarget, scheduler?: FrameScheduler, options?: {
+  maxBytesPerFrame?: number;
+}): BufferedTerminalWriter;
+declare function mountTerminalApp(doc?: Document, dependencies?: MountTerminalDependencies): Promise<MountedTerminalApp>;
+interface MountAittyOptions extends MountTerminalDependencies {
+  document?: Document;
+  loading?: HTMLElement | null;
+  shell?: HTMLElement;
+  status?: HTMLElement | null;
+  terminalRoot?: HTMLElement;
+}
+interface MountAittyContainerOptions extends Omit<MountAittyOptions, "elements" | "loading" | "shell" | "status" | "terminalRoot"> {
+  scrollAdapter?: TerminalScrollAdapterFactory;
+}
+declare function mountAitty(options?: MountAittyOptions): Promise<MountedTerminalApp>;
+declare function mountAitty(container: HTMLElement | string, options?: MountAittyContainerOptions): Promise<MountedTerminalApp>;
+declare function defineAittyTerminalElement(registry?: CustomElementRegistry | undefined): void;
+//#endregion
+export { BinaryWriteTarget, BufferedTerminalWriter, FrameScheduler, MountAittyContainerOptions, MountAittyOptions, MountTerminalDependencies, MountTerminalElements, MountedTerminalApp, TerminalConnectionState, TerminalLoadingPresentation, TerminalOutputState, TerminalScrollAdapter, TerminalScrollAdapterContext, TerminalScrollAdapterFactory, TerminalScrollMetrics, TerminalScrollOptions, TerminalSessionPresentationState, TerminalStatusListener, TerminalStatusSnapshot, TerminalTheme, TerminalTransport, TransportCloseEvent, TransportHandlers, createBufferedTerminalWriter, defineAittyTerminalElement, mountAitty, mountTerminalApp };