nikcli-remote 1.0.9 → 1.0.10

package/dist/index.d.cts

@@ -71,22 +71,6 @@ interface ClientMessage {
     type: string;
     [key: string]: unknown;
 }
-interface ServerMessage {
-    type: string;
-    payload?: unknown;
-    timestamp: number;
-}
-interface TerminalData {
-    data: string;
-}
-interface TerminalResize {
-    cols: number;
-    rows: number;
-}
-interface CommandMessage {
-    command: string;
-    args?: string[];
-}
 interface ClientConnection {
     id: string;
     authenticated: boolean;
@@ -118,8 +102,8 @@ declare const MessageTypes: {
 };
 
 /**
- * @nikcli/remote - Native Remote Server
- * WebSocket-based remote terminal with mobile-friendly web client
+ * @nikcli/remote - Direct Terminal Streaming Server
+ * Proxies NikCLI's stdin/stdout to WebSocket clients for true real-time terminal access
  */
 
 interface RemoteServerEvents {
@@ -130,13 +114,9 @@ interface RemoteServerEvents {
     'client:error': (clientId: string, error: Error) => void;
     'tunnel:connected': (url: string) => void;
     'tunnel:error': (error: Error) => void;
-    command: (cmd: {
-        clientId: string;
-        command: string;
-        args?: string[];
-    }) => void;
     message: (client: ClientConnection, message: ClientMessage) => void;
     error: (error: Error) => void;
+    'terminal:output': (data: string) => void;
 }
 declare class RemoteServer extends EventEmitter {
     private config;
@@ -144,19 +124,31 @@ declare class RemoteServer extends EventEmitter {
     private wss;
     private clients;
     private session;
-    private terminal;
-    private tunnel;
     private heartbeatTimer;
     private sessionTimeoutTimer;
     private isRunning;
     private sessionSecret;
+    private originalStdoutWrite;
+    private originalStdinOn;
     constructor(config?: Partial<ServerConfig>);
     /**
-     * Start the remote server
+     * Generate a random secret
+     */
+    private generateSecret;
+    /**
+     * Start the remote server - creates WebSocket server that proxies stdin/stdout
      */
     start(options?: {
         name?: string;
+        processForStreaming?: {
+            stdout: NodeJS.WriteStream;
+            stdin: NodeJS.ReadStream;
+        };
     }): Promise<RemoteSession>;
+    /**
+     * Setup stdin/stdout proxy to forward to WebSocket clients
+     */
+    private setupStdioProxy;
     /**
      * Stop the server
      */
@@ -164,7 +156,7 @@ declare class RemoteServer extends EventEmitter {
     /**
      * Broadcast message to all authenticated clients
      */
-    broadcast(message: BroadcastMessage): void;
+    private broadcastToAll;
     /**
      * Send notification to clients
      */
@@ -182,13 +174,13 @@ declare class RemoteServer extends EventEmitter {
      */
     getConnectedCount(): number;
     /**
-     * Write to terminal
+     * Write data to all connected clients (for manual output streaming)
      */
-    writeToTerminal(data: string): void;
+    writeToClients(data: string): void;
     /**
-     * Resize terminal
+     * Alias for writeToClients - for compatibility
      */
-    resizeTerminal(cols: number, rows: number): void;
+    writeToTerminal(data: string): void;
     /**
      * Setup WebSocket handlers
      */
@@ -229,59 +221,65 @@ declare class RemoteServer extends EventEmitter {
      * Generate client ID
      */
     private generateClientId;
-    /**
-     * Generate secret
-     */
-    private generateSecret;
 }
 
 /**
- * @nikcli/remote - Terminal Manager
- * PTY-based terminal with fallback to basic spawn
+ * @nikcli/remote - Tunnel Manager
+ * Provides public URL access via various tunnel providers
  */
 
-interface TerminalConfig {
-    shell: string;
-    cols: number;
-    rows: number;
-    cwd?: string;
-    env?: Record<string, string>;
+interface TunnelResult {
+    url: string;
+    provider: TunnelProvider;
+    close: () => Promise<void>;
 }
-declare class TerminalManager extends EventEmitter {
-    private config;
-    private ptyProcess;
+/**
+ * Create a tunnel for the given port using the specified provider
+ */
+declare function createTunnel(port: number, provider?: TunnelProvider): Promise<TunnelResult>;
+declare class TunnelManager {
+    private provider;
     private process;
-    private running;
-    constructor(config: TerminalConfig);
+    private url;
+    private tunnelInstance;
+    constructor(provider: TunnelProvider);
     /**
-     * Start the terminal
+     * Create tunnel and return public URL
      */
-    start(): void;
+    create(port: number): Promise<string>;
     /**
-     * Write data to terminal
+     * Close tunnel
      */
-    write(data: string): void;
+    close(): Promise<void>;
     /**
-     * Resize terminal
+     * Get tunnel URL
      */
-    resize(cols: number, rows: number): void;
+    getUrl(): string | null;
     /**
-     * Clear terminal
+     * Create localtunnel
      */
-    clear(): void;
+    private createLocaltunnel;
     /**
-     * Kill terminal process
+     * Create localtunnel via CLI
      */
-    destroy(): void;
+    private createLocaltunnelCli;
     /**
-     * Check if terminal is running
+     * Create cloudflared tunnel
      */
-    isRunning(): boolean;
+    private createCloudflared;
     /**
-     * Check if using PTY
+     * Create ngrok tunnel
      */
-    hasPty(): boolean;
+    private createNgrok;
 }
+/**
+ * Check if a tunnel provider is available
+ */
+declare function checkTunnelAvailability(provider: TunnelProvider): Promise<boolean>;
+/**
+ * Find best available tunnel provider
+ */
+declare function findAvailableTunnel(): Promise<TunnelProvider | null>;
 
 /**
  * @nikcli/remote - Mobile Web Client
@@ -289,9 +287,37 @@ declare class TerminalManager extends EventEmitter {
  */
 declare function getWebClient(): string;
 
+/**
+ * @nikcli/remote - Enterprise Terminal Streaming
+ *
+ * Direct stdin/stdout streaming for true real-time terminal access.
+ * No fake PTY - mobile sees your actual NikCLI terminal.
+ *
+ * @example
+ * ```typescript
+ * import { RemoteServer, createTunnel } from '@nikcli/remote'
+ *
+ * const server = new RemoteServer()
+ * const session = await server.start({
+ *   name: 'my-terminal',
+ *   processForStreaming: {
+ *     stdout: process.stdout,
+ *     stdin: process.stdin,
+ *   },
+ * })
+ *
+ * // Create public tunnel
+ * const tunnelUrl = await createTunnel(session.port, 'cloudflared')
+ * console.log('Access your terminal:', tunnelUrl)
+ * ```
+ */
+
+/**
+ * Create a remote server with streaming in one call
+ */
 declare function createRemoteServer(config?: Partial<ServerConfig>): Promise<{
     server: RemoteServer;
     session: RemoteSession;
 }>;
 
-export { type BroadcastMessage, type ClientMessage, type CommandMessage, DEFAULT_CONFIG, type DeviceInfo, MessageTypes, type RemoteNotification, RemoteServer, type RemoteServerEvents, type RemoteSession, type ServerConfig, type ServerMessage, type SessionStatus, type TerminalConfig, type TerminalData, TerminalManager, type TerminalResize, type TunnelProvider, createRemoteServer, getWebClient };
+export { type BroadcastMessage, type ClientMessage, DEFAULT_CONFIG, type DeviceInfo, MessageTypes, type RemoteNotification, RemoteServer, type RemoteServerEvents, type RemoteSession, type ServerConfig, type SessionStatus, TunnelManager, type TunnelProvider, type TunnelResult, checkTunnelAvailability, createRemoteServer, createTunnel, findAvailableTunnel, getWebClient };

package/dist/index.d.ts

@@ -71,22 +71,6 @@ interface ClientMessage {
     type: string;
     [key: string]: unknown;
 }
-interface ServerMessage {
-    type: string;
-    payload?: unknown;
-    timestamp: number;
-}
-interface TerminalData {
-    data: string;
-}
-interface TerminalResize {
-    cols: number;
-    rows: number;
-}
-interface CommandMessage {
-    command: string;
-    args?: string[];
-}
 interface ClientConnection {
     id: string;
     authenticated: boolean;
@@ -118,8 +102,8 @@ declare const MessageTypes: {
 };
 
 /**
- * @nikcli/remote - Native Remote Server
- * WebSocket-based remote terminal with mobile-friendly web client
+ * @nikcli/remote - Direct Terminal Streaming Server
+ * Proxies NikCLI's stdin/stdout to WebSocket clients for true real-time terminal access
  */
 
 interface RemoteServerEvents {
@@ -130,13 +114,9 @@ interface RemoteServerEvents {
     'client:error': (clientId: string, error: Error) => void;
     'tunnel:connected': (url: string) => void;
     'tunnel:error': (error: Error) => void;
-    command: (cmd: {
-        clientId: string;
-        command: string;
-        args?: string[];
-    }) => void;
     message: (client: ClientConnection, message: ClientMessage) => void;
     error: (error: Error) => void;
+    'terminal:output': (data: string) => void;
 }
 declare class RemoteServer extends EventEmitter {
     private config;
@@ -144,19 +124,31 @@ declare class RemoteServer extends EventEmitter {
     private wss;
     private clients;
     private session;
-    private terminal;
-    private tunnel;
     private heartbeatTimer;
     private sessionTimeoutTimer;
     private isRunning;
     private sessionSecret;
+    private originalStdoutWrite;
+    private originalStdinOn;
     constructor(config?: Partial<ServerConfig>);
     /**
-     * Start the remote server
+     * Generate a random secret
+     */
+    private generateSecret;
+    /**
+     * Start the remote server - creates WebSocket server that proxies stdin/stdout
      */
     start(options?: {
         name?: string;
+        processForStreaming?: {
+            stdout: NodeJS.WriteStream;
+            stdin: NodeJS.ReadStream;
+        };
     }): Promise<RemoteSession>;
+    /**
+     * Setup stdin/stdout proxy to forward to WebSocket clients
+     */
+    private setupStdioProxy;
     /**
      * Stop the server
      */
@@ -164,7 +156,7 @@ declare class RemoteServer extends EventEmitter {
     /**
      * Broadcast message to all authenticated clients
      */
-    broadcast(message: BroadcastMessage): void;
+    private broadcastToAll;
     /**
      * Send notification to clients
      */
@@ -182,13 +174,13 @@ declare class RemoteServer extends EventEmitter {
      */
     getConnectedCount(): number;
     /**
-     * Write to terminal
+     * Write data to all connected clients (for manual output streaming)
      */
-    writeToTerminal(data: string): void;
+    writeToClients(data: string): void;
     /**
-     * Resize terminal
+     * Alias for writeToClients - for compatibility
      */
-    resizeTerminal(cols: number, rows: number): void;
+    writeToTerminal(data: string): void;
     /**
      * Setup WebSocket handlers
      */
@@ -229,59 +221,65 @@ declare class RemoteServer extends EventEmitter {
      * Generate client ID
      */
     private generateClientId;
-    /**
-     * Generate secret
-     */
-    private generateSecret;
 }
 
 /**
- * @nikcli/remote - Terminal Manager
- * PTY-based terminal with fallback to basic spawn
+ * @nikcli/remote - Tunnel Manager
+ * Provides public URL access via various tunnel providers
  */
 
-interface TerminalConfig {
-    shell: string;
-    cols: number;
-    rows: number;
-    cwd?: string;
-    env?: Record<string, string>;
+interface TunnelResult {
+    url: string;
+    provider: TunnelProvider;
+    close: () => Promise<void>;
 }
-declare class TerminalManager extends EventEmitter {
-    private config;
-    private ptyProcess;
+/**
+ * Create a tunnel for the given port using the specified provider
+ */
+declare function createTunnel(port: number, provider?: TunnelProvider): Promise<TunnelResult>;
+declare class TunnelManager {
+    private provider;
     private process;
-    private running;
-    constructor(config: TerminalConfig);
+    private url;
+    private tunnelInstance;
+    constructor(provider: TunnelProvider);
     /**
-     * Start the terminal
+     * Create tunnel and return public URL
      */
-    start(): void;
+    create(port: number): Promise<string>;
     /**
-     * Write data to terminal
+     * Close tunnel
      */
-    write(data: string): void;
+    close(): Promise<void>;
     /**
-     * Resize terminal
+     * Get tunnel URL
      */
-    resize(cols: number, rows: number): void;
+    getUrl(): string | null;
     /**
-     * Clear terminal
+     * Create localtunnel
      */
-    clear(): void;
+    private createLocaltunnel;
     /**
-     * Kill terminal process
+     * Create localtunnel via CLI
      */
-    destroy(): void;
+    private createLocaltunnelCli;
     /**
-     * Check if terminal is running
+     * Create cloudflared tunnel
      */
-    isRunning(): boolean;
+    private createCloudflared;
     /**
-     * Check if using PTY
+     * Create ngrok tunnel
      */
-    hasPty(): boolean;
+    private createNgrok;
 }
+/**
+ * Check if a tunnel provider is available
+ */
+declare function checkTunnelAvailability(provider: TunnelProvider): Promise<boolean>;
+/**
+ * Find best available tunnel provider
+ */
+declare function findAvailableTunnel(): Promise<TunnelProvider | null>;
 
 /**
  * @nikcli/remote - Mobile Web Client
@@ -289,9 +287,37 @@ declare class TerminalManager extends EventEmitter {
  */
 declare function getWebClient(): string;
 
+/**
+ * @nikcli/remote - Enterprise Terminal Streaming
+ *
+ * Direct stdin/stdout streaming for true real-time terminal access.
+ * No fake PTY - mobile sees your actual NikCLI terminal.
+ *
+ * @example
+ * ```typescript
+ * import { RemoteServer, createTunnel } from '@nikcli/remote'
+ *
+ * const server = new RemoteServer()
+ * const session = await server.start({
+ *   name: 'my-terminal',
+ *   processForStreaming: {
+ *     stdout: process.stdout,
+ *     stdin: process.stdin,
+ *   },
+ * })
+ *
+ * // Create public tunnel
+ * const tunnelUrl = await createTunnel(session.port, 'cloudflared')
+ * console.log('Access your terminal:', tunnelUrl)
+ * ```
+ */
+
+/**
+ * Create a remote server with streaming in one call
+ */
 declare function createRemoteServer(config?: Partial<ServerConfig>): Promise<{
     server: RemoteServer;
     session: RemoteSession;
 }>;
 
-export { type BroadcastMessage, type ClientMessage, type CommandMessage, DEFAULT_CONFIG, type DeviceInfo, MessageTypes, type RemoteNotification, RemoteServer, type RemoteServerEvents, type RemoteSession, type ServerConfig, type ServerMessage, type SessionStatus, type TerminalConfig, type TerminalData, TerminalManager, type TerminalResize, type TunnelProvider, createRemoteServer, getWebClient };
+export { type BroadcastMessage, type ClientMessage, DEFAULT_CONFIG, type DeviceInfo, MessageTypes, type RemoteNotification, RemoteServer, type RemoteServerEvents, type RemoteSession, type ServerConfig, type SessionStatus, TunnelManager, type TunnelProvider, type TunnelResult, checkTunnelAvailability, createRemoteServer, createTunnel, findAvailableTunnel, getWebClient };