green-screen-react 0.3.0 → 1.0.0

package/dist/index.d.ts

@@ -1,10 +1,8 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
+import { ScreenData, ConnectionStatus, ConnectConfig, ProtocolType } from 'green-screen-types';
+export { ConnectConfig, ConnectionStatus, Field, ScreenData, ProtocolType as TerminalProtocol } from 'green-screen-types';
 
-/**
- * Supported terminal protocol types.
- */
-type TerminalProtocol = 'tn5250' | 'tn3270' | 'vt' | 'hp6530';
 /**
  * Protocol-specific color/rendering conventions.
  */
@@ -22,7 +20,7 @@ interface ProtocolColorProfile {
  */
 interface ProtocolProfile {
     /** Protocol identifier */
-    protocol: TerminalProtocol;
+    protocol: string;
     /** Human-readable name */
     displayName: string;
     /** Default terminal dimensions */
@@ -35,65 +33,6 @@ interface ProtocolProfile {
     /** Boot loader default text */
     bootText: string;
 }
-/**
- * Field definition from the terminal data stream.
- * Describes an input or protected field on the terminal screen.
- */
-interface Field {
-    /** 0-based row index */
-    row: number;
-    /** 0-based column index */
-    col: number;
-    /** Field length in characters */
-    length: number;
-    /** Whether the field accepts user input */
-    is_input: boolean;
-    /** Whether the field is protected (read-only) */
-    is_protected: boolean;
-    /** Whether the field is displayed with high intensity (bright/white) */
-    is_highlighted?: boolean;
-    /** Whether the field is displayed in reverse video */
-    is_reverse?: boolean;
-}
-/**
- * Screen data returned by the adapter.
- * Represents the current state of the terminal screen.
- */
-interface ScreenData {
-    /** Screen content as newline-separated text (e.g. 24 lines of 80 chars) */
-    content: string;
-    /** 0-based cursor row */
-    cursor_row: number;
-    /** 0-based cursor column */
-    cursor_col: number;
-    /** Number of rows (default 24) */
-    rows?: number;
-    /** Number of columns (default 80) */
-    cols?: number;
-    /** Field definitions on the current screen */
-    fields?: Field[];
-    /** Unique identifier for the current screen state */
-    screen_signature?: string;
-    /** ISO timestamp of when this screen was captured */
-    timestamp?: string;
-}
-/**
- * Connection status information.
- */
-interface ConnectionStatus {
-    /** Whether a TCP connection is established */
-    connected: boolean;
-    /** Current connection state */
-    status: 'disconnected' | 'connecting' | 'connected' | 'authenticated' | 'error';
-    /** Terminal protocol in use */
-    protocol?: TerminalProtocol;
-    /** Host address */
-    host?: string;
-    /** Authenticated username */
-    username?: string;
-    /** Error message if status is 'error' */
-    error?: string;
-}
 /**
  * Result from a send operation (text or key).
  */
@@ -133,29 +72,16 @@ interface TerminalAdapter {
     /** Reconnect to the host */
     reconnect(): Promise<SendResult>;
 }
-/**
- * Configuration passed from the inline sign-in form to adapter.connect().
- */
-interface ConnectConfig {
-    /** Target host address */
-    host: string;
-    /** Target port (optional, adapter/server can default per protocol) */
-    port?: number;
-    /** Terminal protocol */
-    protocol: TerminalProtocol;
-    /** Username for authentication */
-    username: string;
-    /** Password for authentication */
-    password: string;
-}
-/** @deprecated Use `TerminalAdapter` instead */
-type TN5250Adapter = TerminalAdapter;
 
 interface GreenScreenTerminalProps {
-    /** Adapter for communicating with the terminal backend */
-    adapter: TerminalAdapter;
+    /** Adapter for communicating with the terminal backend (optional — auto-created from sign-in form or baseUrl) */
+    adapter?: TerminalAdapter;
+    /** Base URL for the terminal API — convenience shorthand that auto-creates a RestAdapter */
+    baseUrl?: string;
+    /** Worker/proxy WebSocket URL — convenience shorthand that auto-creates a WebSocketAdapter */
+    workerUrl?: string;
     /** Terminal protocol (determines color conventions, header label, etc.) */
-    protocol?: TerminalProtocol;
+    protocol?: ProtocolType;
     /** Custom protocol profile (overrides protocol param) */
     protocolProfile?: ProtocolProfile;
     /** Direct screen data injection (bypasses polling) */
@@ -178,12 +104,16 @@ interface GreenScreenTerminalProps {
     typingAnimation?: boolean;
     /** Typing animation budget in ms (default 60) */
     typingBudgetMs?: number;
-    /** Show inline sign-in form when disconnected (default false) */
+    /** Show inline sign-in form when disconnected (default true) */
     inlineSignIn?: boolean;
     /** Default protocol for the sign-in form dropdown (default 'tn5250') */
-    defaultProtocol?: TerminalProtocol;
+    defaultProtocol?: ProtocolType;
     /** Callback when sign-in form is submitted */
     onSignIn?: (config: ConnectConfig) => void;
+    /** Show "press Enter to continue" hint after auto sign-in (for external adapter flows) */
+    autoSignedIn?: boolean;
+    /** Disable auto-focus on the terminal after connecting (default false) */
+    autoFocusDisabled?: boolean;
     /** Custom boot loader element, or false to disable */
     bootLoader?: React.ReactNode | false;
     /** Content for the right side of the header */
@@ -201,8 +131,6 @@ interface GreenScreenTerminalProps {
     /** Inline styles */
     style?: React.CSSProperties;
 }
-/** @deprecated Use GreenScreenTerminalProps instead */
-type TN5250TerminalProps = GreenScreenTerminalProps;
 /**
  * GreenScreenTerminal — Multi-protocol legacy terminal emulator component.
  *
@@ -216,9 +144,7 @@ type TN5250TerminalProps = GreenScreenTerminalProps;
  *
  * Supports: TN5250 (IBM i), TN3270 (z/OS), VT (OpenVMS/Pick), HP 6530 (NonStop)
  */
-declare function GreenScreenTerminal({ adapter, protocol, protocolProfile: customProfile, screenData: externalScreenData, connectionStatus: externalStatus, readOnly, pollInterval, autoReconnect: autoReconnectEnabled, maxReconnectAttempts: maxAttempts, embedded, showHeader, typingAnimation, typingBudgetMs, inlineSignIn, defaultProtocol: signInDefaultProtocol, onSignIn, bootLoader, headerRight, overlay, onNotification, onScreenChange, onMinimize, className, style, }: GreenScreenTerminalProps): react_jsx_runtime.JSX.Element;
-/** @deprecated Use GreenScreenTerminal instead */
-declare const TN5250Terminal: typeof GreenScreenTerminal;
+declare function GreenScreenTerminal({ adapter: externalAdapter, baseUrl, workerUrl, protocol, protocolProfile: customProfile, screenData: externalScreenData, connectionStatus: externalStatus, readOnly, pollInterval, autoReconnect: autoReconnectEnabled, maxReconnectAttempts: maxAttempts, embedded, showHeader, typingAnimation, typingBudgetMs, inlineSignIn, defaultProtocol: signInDefaultProtocol, onSignIn, autoSignedIn, autoFocusDisabled, bootLoader, headerRight, overlay, onNotification, onScreenChange, onMinimize, className, style, }: GreenScreenTerminalProps): react_jsx_runtime.JSX.Element;
 
 interface TerminalBootLoaderProps {
     /** Text to display during boot animation */
@@ -236,6 +162,40 @@ interface TerminalBootLoaderProps {
  */
 declare function TerminalBootLoader({ brandText, charSpeed, logo, height, }: TerminalBootLoaderProps): react_jsx_runtime.JSX.Element;
 
+interface InlineSignInProps {
+    defaultProtocol: ProtocolType;
+    loading: boolean;
+    error: string | null;
+    onConnect: (config: ConnectConfig) => void;
+}
+declare function InlineSignIn({ defaultProtocol, loading: externalLoading, error, onConnect }: InlineSignInProps): react_jsx_runtime.JSX.Element;
+
+declare const TerminalIcon: ({ size }: {
+    size?: number;
+}) => react_jsx_runtime.JSX.Element;
+declare const WifiIcon: ({ size, className, style: s }: {
+    size?: number;
+    className?: string;
+    style?: React.CSSProperties;
+}) => react_jsx_runtime.JSX.Element;
+declare const WifiOffIcon: ({ size, className, style: s }: {
+    size?: number;
+    className?: string;
+    style?: React.CSSProperties;
+}) => react_jsx_runtime.JSX.Element;
+declare const AlertTriangleIcon: ({ size }: {
+    size?: number;
+}) => react_jsx_runtime.JSX.Element;
+declare const RefreshIcon: ({ size, className }: {
+    size?: number;
+    className?: string;
+}) => react_jsx_runtime.JSX.Element;
+declare const KeyIcon: ({ size, style: s }: {
+    size?: number;
+    style?: React.CSSProperties;
+}) => react_jsx_runtime.JSX.Element;
+declare const MinimizeIcon: () => react_jsx_runtime.JSX.Element;
+
 interface RestAdapterOptions {
     /** Base URL for the terminal API (e.g. "https://myhost.com/api/terminal") */
     baseUrl: string;
@@ -272,6 +232,65 @@ declare class RestAdapter implements TerminalAdapter {
     reconnect(): Promise<SendResult>;
 }
 
+interface WebSocketAdapterOptions {
+    /** URL of the green-screen proxy or worker. Auto-detected from env vars, defaults to http://localhost:3001 */
+    workerUrl?: string;
+}
+/**
+ * WebSocket adapter that connects to a green-screen proxy or Cloudflare Worker.
+ * The backend holds the TCP connection to the legacy host and relays protocol data.
+ *
+ * Unlike RestAdapter (which polls over HTTP), this adapter receives real-time
+ * screen updates via WebSocket push.
+ *
+ * workerUrl resolution order:
+ *   1. Explicit `workerUrl` option
+ *   2. VITE_GREEN_SCREEN_URL / VITE_WORKER_URL (Vite)
+ *   3. NEXT_PUBLIC_GREEN_SCREEN_URL (Next.js)
+ *   4. REACT_APP_GREEN_SCREEN_URL (CRA)
+ *   5. http://localhost:3001
+ */
+declare class WebSocketAdapter implements TerminalAdapter {
+    private workerUrl;
+    private ws;
+    private screen;
+    private status;
+    private pendingScreenResolver;
+    private pendingConnectResolver;
+    private connectingPromise;
+    private screenListeners;
+    private statusListeners;
+    private _sessionId;
+    constructor(options?: WebSocketAdapterOptions);
+    private static detectEnvUrl;
+    /** The proxy-side session ID (available after connect or reattach) */
+    get sessionId(): string | null;
+    /** Subscribe to real-time screen updates */
+    onScreen(listener: (screen: ScreenData) => void): () => void;
+    /** Subscribe to status changes */
+    onStatus(listener: (status: ConnectionStatus) => void): () => void;
+    getScreen(): Promise<ScreenData | null>;
+    getStatus(): Promise<ConnectionStatus>;
+    sendText(text: string): Promise<SendResult>;
+    sendKey(key: string): Promise<SendResult>;
+    connect(config?: ConnectConfig): Promise<SendResult>;
+    /**
+     * Reattach to an existing proxy session (e.g. after page reload).
+     * The proxy keeps the TCP connection alive; this just reconnects the
+     * WebSocket and receives the current screen.
+     */
+    reattach(sessionId: string): Promise<SendResult>;
+    disconnect(): Promise<SendResult>;
+    reconnect(): Promise<SendResult>;
+    /** Close the WebSocket without sending disconnect (session stays alive on proxy) */
+    dispose(): void;
+    private ensureWebSocket;
+    private handleMessage;
+    private sendAndWaitForScreen;
+    private screenToResult;
+    private wsSend;
+}
+
 /**
  * Hook for typing animation effect on terminal screen content.
  * Reveals characters progressively when screen content changes.
@@ -342,17 +361,11 @@ declare function useTerminalInput(adapter: TerminalAdapter): {
     sendText: (text: string) => Promise<SendResult>;
     sendKey: (key: string) => Promise<SendResult>;
 };
-/** @deprecated Use `useTerminalConnection` instead */
-declare const useTN5250Connection: typeof useTerminalConnection;
-/** @deprecated Use `useTerminalScreen` instead */
-declare const useTN5250Screen: typeof useTerminalScreen;
-/** @deprecated Use `useTerminalInput` instead */
-declare const useTN5250Terminal: typeof useTerminalInput;
 
 /**
  * Get a protocol profile by type. Defaults to TN5250 for backward compatibility.
  */
-declare function getProtocolProfile(protocol?: TerminalProtocol): ProtocolProfile;
+declare function getProtocolProfile(protocol?: ProtocolType): ProtocolProfile;
 
 declare const tn5250Profile: ProtocolProfile;
 
@@ -397,4 +410,4 @@ declare function parseHeaderRow(line: string): {
     colorClass: string;
 }[] | null;
 
-export { type ConnectConfig, type ConnectionStatus, type Field, GreenScreenTerminal, type GreenScreenTerminalProps, type ProtocolColorProfile, type ProtocolProfile, RestAdapter, type RestAdapterOptions, type ScreenData, type SendResult, type TN5250Adapter, TN5250Terminal, type TN5250TerminalProps, type TerminalAdapter, TerminalBootLoader, type TerminalBootLoaderProps, type TerminalProtocol, getProtocolProfile, getRowColorClass, hp6530Profile, isFieldEntry, parseHeaderRow, positionToRowCol, tn3270Profile, tn5250Profile, useTN5250Connection, useTN5250Screen, useTN5250Terminal, useTerminalConnection, useTerminalInput, useTerminalScreen, useTypingAnimation, vtProfile };
+export { AlertTriangleIcon, GreenScreenTerminal, type GreenScreenTerminalProps, InlineSignIn, type InlineSignInProps, KeyIcon, MinimizeIcon, type ProtocolColorProfile, type ProtocolProfile, RefreshIcon, RestAdapter, type RestAdapterOptions, type SendResult, type TerminalAdapter, TerminalBootLoader, type TerminalBootLoaderProps, TerminalIcon, WebSocketAdapter, type WebSocketAdapterOptions, WifiIcon, WifiOffIcon, getProtocolProfile, getRowColorClass, hp6530Profile, isFieldEntry, parseHeaderRow, positionToRowCol, tn3270Profile, tn5250Profile, useTerminalConnection, useTerminalInput, useTerminalScreen, useTypingAnimation, vtProfile };