@push.rocks/smartshell 3.2.4 → 3.3.0

package/dist_ts/00_commitinfo_data.js

@@ -3,7 +3,7 @@
  */
 export const commitinfo = {
     name: '@push.rocks/smartshell',
-    version: '3.2.4',
+    version: '3.3.0',
     description: 'A library for executing shell commands using promises.'
 };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx3QkFBd0I7SUFDOUIsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLHdEQUF3RDtDQUN0RSxDQUFBIn0=

package/dist_ts/classes.smartshell.d.ts

@@ -5,6 +5,14 @@ import * as cp from 'child_process';
 export interface IExecResult {
     exitCode: number;
     stdout: string;
+    signal?: NodeJS.Signals;
+    stderr?: string;
+}
+export interface IExecResultInteractive extends IExecResult {
+    sendInput: (input: string) => Promise<void>;
+    sendLine: (line: string) => Promise<void>;
+    endInput: () => void;
+    finalPromise: Promise<IExecResult>;
 }
 export interface IExecResultStreaming {
     childProcess: cp.ChildProcess;
@@ -13,6 +21,33 @@ export interface IExecResultStreaming {
     terminate: () => Promise<void>;
     keyboardInterrupt: () => Promise<void>;
     customSignal: (signal: plugins.smartexit.TProcessSignal) => Promise<void>;
+    sendInput: (input: string) => Promise<void>;
+    sendLine: (line: string) => Promise<void>;
+    endInput: () => void;
+}
+interface IExecOptions {
+    commandString: string;
+    silent?: boolean;
+    strict?: boolean;
+    streaming?: boolean;
+    interactive?: boolean;
+    passthrough?: boolean;
+    interactiveControl?: boolean;
+    usePty?: boolean;
+    ptyCols?: number;
+    ptyRows?: number;
+    ptyTerm?: string;
+    ptyShell?: string;
+    maxBuffer?: number;
+    onData?: (chunk: Buffer | string) => void;
+    timeout?: number;
+    debug?: boolean;
+    env?: NodeJS.ProcessEnv;
+    signal?: AbortSignal;
+}
+export interface ISpawnOptions extends Omit<IExecOptions, 'commandString'> {
+    command: string;
+    args?: string[];
 }
 export declare class Smartshell {
     shellEnv: ShellEnv;
@@ -26,6 +61,10 @@ export declare class Smartshell {
      * Executes an interactive command.
      */
     private _execInteractive;
+    /**
+     * Executes a command with args array (shell:false) for security
+     */
+    private _execSpawn;
     /**
      * Executes a command and returns either a non-streaming result or a streaming interface.
      */
@@ -37,6 +76,35 @@ export declare class Smartshell {
     execStreaming(commandString: string, silent?: boolean): Promise<IExecResultStreaming>;
     execStreamingSilent(commandString: string): Promise<IExecResultStreaming>;
     execInteractive(commandString: string): Promise<void>;
-    execAndWaitForLine(commandString: string, regex: RegExp, silent?: boolean): Promise<void>;
-    execAndWaitForLineSilent(commandString: string, regex: RegExp): Promise<void>;
+    execPassthrough(commandString: string): Promise<IExecResult>;
+    execStreamingPassthrough(commandString: string): Promise<IExecResultStreaming>;
+    execInteractiveControl(commandString: string): Promise<IExecResultInteractive>;
+    execStreamingInteractiveControl(commandString: string): Promise<IExecResultStreaming>;
+    execInteractiveControlPty(commandString: string): Promise<IExecResultInteractive>;
+    execStreamingInteractiveControlPty(commandString: string): Promise<IExecResultStreaming>;
+    /**
+     * Executes a command with args array (shell:false) for security
+     * This is the recommended API for untrusted input
+     */
+    execSpawn(command: string, args?: string[], options?: Omit<ISpawnOptions, 'command' | 'args'>): Promise<IExecResult>;
+    /**
+     * Executes a command with args array in streaming mode
+     */
+    execSpawnStreaming(command: string, args?: string[], options?: Omit<ISpawnOptions, 'command' | 'args' | 'streaming'>): Promise<IExecResultStreaming>;
+    /**
+     * Executes a command with args array with interactive control
+     */
+    execSpawnInteractiveControl(command: string, args?: string[], options?: Omit<ISpawnOptions, 'command' | 'args' | 'interactiveControl'>): Promise<IExecResultInteractive>;
+    execAndWaitForLine(commandString: string, regex: RegExp, silent?: boolean, options?: {
+        timeout?: number;
+        terminateOnMatch?: boolean;
+    }): Promise<void>;
+    execAndWaitForLineSilent(commandString: string, regex: RegExp, options?: {
+        timeout?: number;
+        terminateOnMatch?: boolean;
+    }): Promise<void>;
+    private nodePty;
+    private lazyLoadNodePty;
+    private _execCommandPty;
 }
+export {};