shellx-ai 1.0.12 → 1.1.1

package/dist/shell/output-buffer.d.ts

@@ -0,0 +1,152 @@
+/**
+ * OutputBuffer - A module for managing shell command output buffering
+ *
+ * This module handles buffering, processing, and managing output from shell commands
+ * across multiple sessions, with support for output cleaning and combination.
+ */
+/**
+ * Options for shell command execution
+ */
+export interface ShellCommandOptions {
+    /** Title for the command (used for logging) */
+    title?: string;
+    /** Timeout in milliseconds */
+    timeout?: number;
+    /** Wait time after command execution in milliseconds */
+    waitAfterMs?: number;
+    /** Callback for handling output chunks as they arrive */
+    onOutput?: (output: string) => void;
+    /** Callback for handling error messages */
+    onError?: (error: string) => void;
+    /** Expected output pattern (string or RegExp) */
+    expectedOutput?: string | RegExp;
+    /** Success pattern to match in output (string or RegExp) */
+    successPattern?: string | RegExp;
+    /** Whether to allow returning partial results on timeout */
+    allowPartialResult?: boolean;
+    /** Whether to automatically set Android PATH (default: true) */
+    setAndroidPath?: boolean;
+}
+/**
+ * Result of a shell command execution
+ */
+export interface ShellCommandResult {
+    /** Whether the command executed successfully */
+    success: boolean;
+    /** The command output */
+    output: string;
+    /** Error message if command failed */
+    error?: string;
+    /** Exit code of the command */
+    exitCode?: number;
+    /** Duration of command execution in milliseconds */
+    duration: number;
+}
+/**
+ * Internal promise representation for a pending shell command
+ */
+interface CommandPromise {
+    /** Resolve function for the promise */
+    resolve: (result: ShellCommandResult) => void;
+    /** Reject function for the promise */
+    reject: (error: Error) => void;
+    /** Start time of the command */
+    startTime: number;
+    /** Execution options */
+    options: ShellCommandOptions;
+    /** Accumulated output */
+    output: string;
+    /** Session-specific outputs */
+    sessionOutputs: Map<number, string>;
+    /** Original command string */
+    command: string;
+}
+/**
+ * OutputBuffer class manages shell command output buffering and processing
+ *
+ * This class handles:
+ * - Buffering output from multiple shell command sessions
+ * - Managing pending command promises
+ * - Cleaning and combining output from different sessions
+ * - Providing access to accumulated command results
+ */
+export declare class OutputBuffer {
+    /** Map of pending command promises keyed by command ID */
+    private commandPromises;
+    /**
+     * Register a new command promise for tracking
+     *
+     * @param commandId - Unique identifier for the command
+     * @param resolve - Promise resolve function
+     * @param reject - Promise reject function
+     * @param startTime - Command start timestamp
+     * @param options - Command execution options
+     * @param command - Original command string
+     */
+    registerCommand(commandId: string, resolve: (result: ShellCommandResult) => void, reject: (error: Error) => void, startTime: number, options: ShellCommandOptions, command: string): void;
+    /**
+     * Unregister and resolve a command promise
+     *
+     * @param commandId - Unique identifier for the command
+     * @returns The command promise data if found, undefined otherwise
+     */
+    unregisterCommand(commandId: string): CommandPromise | undefined;
+    /**
+     * Get a registered command promise
+     *
+     * @param commandId - Unique identifier for the command
+     * @returns The command promise data if found, undefined otherwise
+     */
+    getCommand(commandId: string): CommandPromise | undefined;
+    /**
+     * Check if a command is registered
+     *
+     * @param commandId - Unique identifier for the command
+     * @returns True if the command is registered, false otherwise
+     */
+    hasCommand(commandId: string): boolean;
+    /**
+     * Get the number of pending commands
+     *
+     * @returns The number of currently registered commands
+     */
+    getPendingCount(): number;
+    /**
+     * Handle incoming shell output chunks
+     *
+     * This method processes output from shell sessions and distributes it
+     * to all waiting commands.
+     *
+     * @param sessionId - The session ID for the output
+     * @param chunks - Array of Uint8Array data chunks
+     */
+    handleShellOutput(sessionId: number, chunks: Uint8Array[]): void;
+    /**
+     * Clean command output by removing the command itself
+     *
+     * @param output - The raw output string
+     * @param command - The command string to remove
+     * @returns Cleaned output string
+     */
+    cleanCommandOutput(output: string, command: string): string;
+    /**
+     * Combine outputs from multiple sessions into a single string
+     *
+     * @param sessionOutputs - Map of session IDs to their outputs
+     * @returns Combined output string
+     */
+    private combineSessionOutputs;
+    /**
+     * Clear all registered commands
+     *
+     * This method is useful for cleanup or reset scenarios
+     */
+    clear(): void;
+    /**
+     * Get all registered command IDs
+     *
+     * @returns Array of command IDs
+     */
+    getCommandIds(): string[];
+}
+export {};

package/dist/shell/output-buffer.js

@@ -0,0 +1,176 @@
+/**
+ * OutputBuffer - A module for managing shell command output buffering
+ *
+ * This module handles buffering, processing, and managing output from shell commands
+ * across multiple sessions, with support for output cleaning and combination.
+ */
+import { createLogger } from "../logger.js";
+// Create logger for OutputBuffer
+const logger = createLogger("OutputBuffer");
+/**
+ * OutputBuffer class manages shell command output buffering and processing
+ *
+ * This class handles:
+ * - Buffering output from multiple shell command sessions
+ * - Managing pending command promises
+ * - Cleaning and combining output from different sessions
+ * - Providing access to accumulated command results
+ */
+export class OutputBuffer {
+    /** Map of pending command promises keyed by command ID */
+    commandPromises = new Map();
+    /**
+     * Register a new command promise for tracking
+     *
+     * @param commandId - Unique identifier for the command
+     * @param resolve - Promise resolve function
+     * @param reject - Promise reject function
+     * @param startTime - Command start timestamp
+     * @param options - Command execution options
+     * @param command - Original command string
+     */
+    registerCommand(commandId, resolve, reject, startTime, options, command) {
+        this.commandPromises.set(commandId, {
+            resolve,
+            reject,
+            startTime,
+            options,
+            output: "",
+            sessionOutputs: new Map(),
+            command,
+        });
+        logger.info(`📋 Registered command: ${commandId}`);
+        logger.debug(`📊 Pending commands: ${this.commandPromises.size}`);
+    }
+    /**
+     * Unregister and resolve a command promise
+     *
+     * @param commandId - Unique identifier for the command
+     * @returns The command promise data if found, undefined otherwise
+     */
+    unregisterCommand(commandId) {
+        const commandPromise = this.commandPromises.get(commandId);
+        if (commandPromise) {
+            this.commandPromises.delete(commandId);
+            logger.info(`✅ Unregistered command: ${commandId}`);
+        }
+        return commandPromise;
+    }
+    /**
+     * Get a registered command promise
+     *
+     * @param commandId - Unique identifier for the command
+     * @returns The command promise data if found, undefined otherwise
+     */
+    getCommand(commandId) {
+        return this.commandPromises.get(commandId);
+    }
+    /**
+     * Check if a command is registered
+     *
+     * @param commandId - Unique identifier for the command
+     * @returns True if the command is registered, false otherwise
+     */
+    hasCommand(commandId) {
+        return this.commandPromises.has(commandId);
+    }
+    /**
+     * Get the number of pending commands
+     *
+     * @returns The number of currently registered commands
+     */
+    getPendingCount() {
+        return this.commandPromises.size;
+    }
+    /**
+     * Handle incoming shell output chunks
+     *
+     * This method processes output from shell sessions and distributes it
+     * to all waiting commands.
+     *
+     * @param sessionId - The session ID for the output
+     * @param chunks - Array of Uint8Array data chunks
+     */
+    handleShellOutput(sessionId, chunks) {
+        try {
+            // Decode chunks to string
+            let output = "";
+            for (const data of chunks) {
+                // Validate data is a valid Uint8Array
+                if (!data || !(data instanceof Uint8Array) || data.length === 0) {
+                    logger.warn(`⚠️  Skipping invalid chunk:`, {
+                        type: typeof data,
+                        isUint8Array: data instanceof Uint8Array,
+                        length: data?.length,
+                        data: data,
+                    });
+                    continue;
+                }
+                output += new TextDecoder().decode(data);
+            }
+            // Distribute output to all waiting commands
+            for (const [_commandId, commandPromise] of this.commandPromises.entries()) {
+                // Initialize session output if not exists
+                if (!commandPromise.sessionOutputs.has(sessionId)) {
+                    commandPromise.sessionOutputs.set(sessionId, "");
+                }
+                // Accumulate session output
+                const currentSessionOutput = commandPromise.sessionOutputs.get(sessionId) || "";
+                commandPromise.sessionOutputs.set(sessionId, currentSessionOutput + output);
+                // Update combined output
+                commandPromise.output = this.combineSessionOutputs(commandPromise.sessionOutputs);
+                // Call output callback if provided
+                if (commandPromise.options.onOutput) {
+                    const cleanOutput = this.cleanCommandOutput(output, commandPromise.command);
+                    commandPromise.options.onOutput(cleanOutput);
+                }
+            }
+        }
+        catch (error) {
+            logger.error(`❌ Failed to handle shell output:`, error);
+        }
+    }
+    /**
+     * Clean command output by removing the command itself
+     *
+     * @param output - The raw output string
+     * @param command - The command string to remove
+     * @returns Cleaned output string
+     */
+    cleanCommandOutput(output, command) {
+        return output.replace(command, "");
+    }
+    /**
+     * Combine outputs from multiple sessions into a single string
+     *
+     * @param sessionOutputs - Map of session IDs to their outputs
+     * @returns Combined output string
+     */
+    combineSessionOutputs(sessionOutputs) {
+        const sessions = Array.from(sessionOutputs.keys()).sort();
+        let combined = "";
+        for (const sessionId of sessions) {
+            const sessionOutput = sessionOutputs.get(sessionId) || "";
+            combined += sessionOutput;
+        }
+        return combined;
+    }
+    /**
+     * Clear all registered commands
+     *
+     * This method is useful for cleanup or reset scenarios
+     */
+    clear() {
+        this.commandPromises.clear();
+        logger.debug("🧹 Cleared all command promises");
+    }
+    /**
+     * Get all registered command IDs
+     *
+     * @returns Array of command IDs
+     */
+    getCommandIds() {
+        return Array.from(this.commandPromises.keys());
+    }
+}
+//# sourceMappingURL=output-buffer.js.map

package/dist/shell/output-buffer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output-buffer.js","sourceRoot":"","sources":["../../src/shell/output-buffer.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C,iCAAiC;AACjC,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;AA8D5C;;;;;;;;GAQG;AACH,MAAM,OAAO,YAAY;IACvB,0DAA0D;IAClD,eAAe,GAAgC,IAAI,GAAG,EAAE,CAAC;IAEjE;;;;;;;;;OASG;IACH,eAAe,CACb,SAAiB,EACjB,OAA6C,EAC7C,MAA8B,EAC9B,SAAiB,EACjB,OAA4B,EAC5B,OAAe;QAEf,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,EAAE;YAClC,OAAO;YACP,MAAM;YACN,SAAS;YACT,OAAO;YACP,MAAM,EAAE,EAAE;YACV,cAAc,EAAE,IAAI,GAAG,EAAE;YACzB,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,CAAC,IAAI,CAAC,0BAA0B,SAAS,EAAE,CAAC,CAAC;QACnD,MAAM,CAAC,KAAK,CAAC,wBAAwB,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CAAC,SAAiB;QACjC,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,cAAc,EAAE,CAAC;YACnB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,2BAA2B,SAAS,EAAE,CAAC,CAAC;QACtD,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,SAAiB;QAC1B,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,SAAiB;QAC1B,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;IACnC,CAAC;IAED;;;;;;;;OAQG;IACH,iBAAiB,CAAC,SAAiB,EAAE,MAAoB;QACvD,IAAI,CAAC;YACH,0BAA0B;YAC1B,IAAI,MAAM,GAAG,EAAE,CAAC;YAChB,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;gBAC1B,sCAAsC;gBACtC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,YAAY,UAAU,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAChE,MAAM,CAAC,IAAI,CAAC,6BAA6B,EAAE;wBACzC,IAAI,EAAE,OAAO,IAAI;wBACjB,YAAY,EAAE,IAAI,YAAY,UAAU;wBACxC,MAAM,EAAE,IAAI,EAAE,MAAM;wBACpB,IAAI,EAAE,IAAI;qBACX,CAAC,CAAC;oBACH,SAAS;gBACX,CAAC;gBACD,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC3C,CAAC;YAED,4CAA4C;YAC5C,KAAK,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE,CAAC;gBAC1E,0CAA0C;gBAC1C,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;oBAClD,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;gBACnD,CAAC;gBAED,4BAA4B;gBAC5B,MAAM,oBAAoB,GAAG,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;gBAChF,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,EAAE,oBAAoB,GAAG,MAAM,CAAC,CAAC;gBAE5E,yBAAyB;gBACzB,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;gBAElF,mCAAmC;gBACnC,IAAI,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;oBACpC,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;oBAC5E,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;gBAC/C,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,kCAAkC,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,kBAAkB,CAAC,MAAc,EAAE,OAAe;QAChD,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACK,qBAAqB,CAAC,cAAmC;QAC/D,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAC1D,IAAI,QAAQ,GAAG,EAAE,CAAC;QAElB,KAAK,MAAM,SAAS,IAAI,QAAQ,EAAE,CAAC;YACjC,MAAM,aAAa,GAAG,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YAC1D,QAAQ,IAAI,aAAa,CAAC;QAC5B,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAC7B,MAAM,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC;CACF"}

package/dist/shell/shell-command-executor.d.ts

@@ -0,0 +1,182 @@
+/**
+ * ShellCommandExecutor - A module for executing shell commands
+ *
+ * This module provides functionality for executing shell commands with
+ * output monitoring, timeout handling, and result management.
+ */
+import type { ActionSequence as LegacyActionSequence } from "../protocol.js";
+import type { ShellCommandResult, ShellCommandOptions } from "./output-buffer.js";
+import { OutputBuffer } from "./output-buffer.js";
+export type { ShellCommandResult, ShellCommandOptions };
+/**
+ * Interface for ConnectionClient methods used by ShellCommandExecutor
+ */
+interface IConnectionClient {
+    sendMessageWithTaskId(message: unknown, type: string, definedTaskId?: string, timeout?: number): Promise<{
+        promise: Promise<unknown>;
+    }>;
+    executeAction(action: LegacyActionSequence): Promise<void>;
+    appendExecutionLog: (log: string) => void;
+}
+/**
+ * ShellCommandExecutor class handles shell command execution
+ *
+ * This class provides methods to:
+ * - Execute single or multiple shell commands
+ * - Monitor command output in real-time
+ * - Handle command timeouts
+ * - Manage command execution state
+ */
+export declare class ShellCommandExecutor {
+    private client;
+    private outputBuffer;
+    /**
+     * Creates a ShellCommandExecutor instance
+     *
+     * @param client - The ConnectionClient instance for command execution
+     */
+    constructor(client: IConnectionClient);
+    /**
+     * Handle shell output data from WebSocket messages
+     *
+     * This method should be called when receiving shell output chunks
+     * from the WebSocket connection.
+     *
+     * @param chunks - Array of [sessionId, length, dataArray] tuples
+     *
+     * @example
+     * ```typescript
+     * // In WebSocket message handler
+     * if (message.chunks) {
+     *   executor.handleShellOutput(message.chunks);
+     * }
+     * ```
+     */
+    handleShellOutput(chunks: [number, number, Uint8Array[]]): void;
+    /**
+     * Execute a shell command with output monitoring
+     *
+     * @param command - The shell command to execute
+     * @param options - Command execution options
+     * @returns Promise resolving to ShellCommandResult
+     *
+     * @example
+     * ```typescript
+     * const result = await executor.executeShellCommand('ls -la', {
+     *   title: 'List files',
+     *   timeout: 5000,
+     *   onOutput: (output) => console.log(output)
+     * });
+     * ```
+     */
+    executeShellCommand(command: string, options?: ShellCommandOptions): Promise<ShellCommandResult>;
+    /**
+     * Execute shell command with simple output (for backward compatibility)
+     *
+     * @param command - The shell command to execute
+     * @param options - Command execution options
+     * @returns Promise resolving to ShellCommandResult
+     *
+     * @example
+     * ```typescript
+     * const result = await executor.executeSimpleShellCommand('pm list packages', {
+     *   title: 'List packages',
+     *   timeout: 10000,
+     *   waitAfterMs: 1000
+     * });
+     * ```
+     */
+    executeSimpleShellCommand(command: string, options?: {
+        title?: string;
+        timeout?: number;
+        waitAfterMs?: number;
+    }): Promise<ShellCommandResult>;
+    /**
+     * Execute multiple shell commands in sequence
+     *
+     * @param commands - Array of command configurations
+     * @param options - Execution options
+     * @returns Promise resolving to array of ShellCommandResult
+     *
+     * @example
+     * ```typescript
+     * const results = await executor.executeShellCommands(
+     *   [
+     *     { command: 'pm list packages', title: 'List packages' },
+     *     { command: 'dumpsys battery', title: 'Get battery info' }
+     *   ],
+     *   {
+     *     continueOnError: true,
+     *     timeout: 5000
+     *   }
+     * );
+     * ```
+     */
+    executeShellCommands(commands: Array<{
+        command: string;
+        title?: string;
+        waitAfterMs?: number;
+    }>, options?: {
+        continueOnError?: boolean;
+        timeout?: number;
+    }): Promise<ShellCommandResult[]>;
+    /**
+     * Execute an ADB command
+     *
+     * @param command - The ADB command to execute (without 'adb' prefix)
+     * @param options - Command execution options
+     * @returns Promise resolving to ShellCommandResult
+     *
+     * @example
+     * ```typescript
+     * const result = await executor.adbCommand('shell pm list packages', {
+     *   title: 'List packages via ADB',
+     *   timeout: 10000
+     * });
+     * ```
+     */
+    adbCommand(command: string, options?: ShellCommandOptions): Promise<ShellCommandResult>;
+    /**
+     * Execute a key action (press a hardware key)
+     *
+     * @param keyCode - The key code to press (e.g., 'KEYCODE_HOME', 'KEYCODE_BACK')
+     * @param options - Execution options
+     * @returns Promise resolving to boolean indicating success
+     *
+     * @example
+     * ```typescript
+     * const success = await executor.executeKeyAction('KEYCODE_HOME', {
+     *   longPress: false,
+     *   waitAfterMs: 500
+     * });
+     * ```
+     */
+    executeKeyAction(keyCode: string, options?: {
+        longPress?: boolean;
+        waitAfterMs?: number;
+    }): Promise<boolean>;
+    /**
+     * Get the underlying client instance
+     *
+     * @returns The ConnectionClient instance
+     */
+    private getClient;
+    /**
+     * Get the output buffer instance
+     *
+     * @returns The OutputBuffer instance
+     */
+    getOutputBuffer(): OutputBuffer;
+    /**
+     * Clear all pending command promises
+     *
+     * This method is useful for cleanup scenarios
+     */
+    clearPendingCommands(): void;
+    /**
+     * Get the number of pending commands
+     *
+     * @returns The number of currently pending commands
+     */
+    getPendingCommandCount(): number;
+}