@j-o-r/sh 1.0.2 → 1.0.4

package/{lib/sh.d.ts → types/SH.d.ts}

@@ -1,60 +1,3 @@
-export type SpawnSyncResponse = {
-    /**
-     * - The exit code of the child process. A value of `0` indicates success.
-     */
-    status: number;
-    /**
-     * - The signal used to terminate the process, if any.
-     */
-    signal: Buffer | null;
-    /**
-     * - An array containing the standard output and standard error of the child process.
-     */
-    output: Array<string | null>;
-    /**
-     * - The process ID of the child process.
-     */
-    pid: number;
-    /**
-     * - The standard output of the child process.
-     */
-    stdout: Buffer | null;
-    /**
-     * - The standard error of the child process.
-     */
-    stderr: Buffer | null;
-};
-/**
- * Default options for the execution environment.
- */
-export type SHOptions = {
-    /**
-     * - The current working directory.
-     */
-    cwd?: string;
-    /**
-     * - The environment variables.
-     */
-    env?: NodeJS.ProcessEnv;
-    /**
-     * - The shell to use for execution.
-     */
-    shell?: string;
-    /**
-     * - The prefix commands to ensure a safe execution environment.
-     */
-    prefix?: string;
-    /**
-     * - The stdio configuration.
-     */
-    stdio?: StdioOptions | StdioOption;
-    /**
-     * - default 20000: a timeout error is triggerd when a process execution time is exceeded, 0 is no timeout
-     */
-    timeout?: number;
-};
-export type StdioOption = ('pipe' | 'ignore' | 'inherit' | number);
-export type StdioOptions = Array<StdioOption> | StdioOption;
 /**
  * Creates a new SHDispatch object that represents a command to be executed.
  */
@@ -63,26 +6,28 @@ export type Shell = Function;
 export const SH: Shell & {
     (pieces: TemplateStringsArray, ...args: any): SHDispatch;
 };
+/**
+ * Splits a command string into an array of arguments, handling quoted strings.
+ * This fixes a problem when a command is like this: SH`${command}`
+ *
+ * @param {string} command - The command string to split.
+ * @returns {string[]} - The array of command arguments.
+ */
+export function args(command: string): string[];
 /**
 * Change working directory
 * @param {string} dir
 */
 export function cd(dir: string): void;
 /**
- * Generates an exponential backoff time with a random jitter.
- *
- * @generator
- * @param {string} [max='60s'] - The maximum backoff time in a human-readable format (e.g., '60s' for 60 seconds).
- * @param {string} [rand='100ms'] - The maximum random jitter time in a human-readable format (e.g., '100ms' for 100 milliseconds).
- * @yields {number} The backoff time in milliseconds.
- */
-export function expBackoff(max?: string, rand?: string): Generator<number, void, unknown>;
-/**
-* This function reads the standard input (stdin) from the current process.
+* This function pauses or "sleeps" code execution for a specified duration.
+* @param {string|number} duration - The duration to pause execution for, e.g., '100ms' or '3s'.
+*
 * @example
-* const content = await stdin();
+*
+* const res = await sleep('5s');
 */
-export function readIn(): Promise<string>;
+export function sleep(duration: string | number): Promise<any>;
 /**
 * Retries a given asynchronous function a specified number of times with optional delays between attempts.
 *
@@ -102,16 +47,13 @@ export function readIn(): Promise<string>;
 * // Retry a command 3 times with irregular intervals using exponential backoff
 * const p = await retry(3, expBackoff(), () => SH`curl -s https://flipwrsi`);
 */
-export function retry(count: number, a: string | typeof expBackoff | Function, b?: Function): Promise<any>;
+export function retry(count: number, a: string | typeof expBackoff | Function, b?: Function | undefined): Promise<any>;
 /**
-* This function pauses or "sleeps" code execution for a specified duration.
-* @param {string|number} duration - The duration to pause execution for, e.g., '100ms' or '3s'.
-*
+* This function reads the standard input (stdin) from the current process.
 * @example
-*
-* const res = await sleep('5s');
+* const content = await stdin();
 */
-export function sleep(duration: string | number): Promise<any>;
+export function readIn(): Promise<string>;
 /**
 * Create a async context in an sync block
 * @param {function} callback - async function
@@ -125,28 +67,13 @@ export function sleep(duration: string | number): Promise<any>;
 *		]);
 */
 export function within(callback: Function): void;
-declare class SHDispatch {
-    /**
-    * @param {string} cmd - cmd to execute
-    */
-    constructor(cmd: string);
-    /**
-    * @param {SHOptions} options
-    * @returns {SHDispatch}
-    */
-    options(options: SHOptions): SHDispatch;
-    /**
-    * @param {string} [payload]
-    * @returns {Promise<string>}
-    */
-    run(payload?: string): Promise<string>;
-    /**
-    * Works for screen takeovers like editors
-    * @param {string} [payload]
-    * @returns {SpawnSyncResponse}
-    */
-    runSync(payload?: string): SpawnSyncResponse;
-    kill(): Promise<void>;
-    #private;
-}
-export {};
+/**
+ * Generates an exponential backoff time with a random jitter.
+ *
+ * @generator
+ * @param {string} [max='60s'] - The maximum backoff time in a human-readable format (e.g., '60s' for 60 seconds).
+ * @param {string} [rand='100ms'] - The maximum random jitter time in a human-readable format (e.g., '100ms' for 100 milliseconds).
+ * @yields {number} The backoff time in milliseconds.
+ */
+export function expBackoff(max?: string | undefined, rand?: string | undefined): Generator<number, void, unknown>;
+import SHDispatch from './SHDispatch.js';

package/types/SHDispatch.d.ts

@@ -0,0 +1,82 @@
+export default SHDispatch;
+export type SpawnSyncResponse = {
+    /**
+     * - The exit code of the child process. A value of `0` indicates success.
+     */
+    status: number;
+    /**
+     * - The signal used to terminate the process, if any.
+     */
+    signal: Buffer | null;
+    /**
+     * - An array containing the standard output and standard error of the child process.
+     */
+    output: Array<string | null>;
+    /**
+     * - The process ID of the child process.
+     */
+    pid: number;
+    /**
+     * - The standard output of the child process.
+     */
+    stdout: Buffer | null;
+    /**
+     * - The standard error of the child process.
+     */
+    stderr: Buffer | null;
+};
+/**
+ * Default options for the execution environment.
+ */
+export type SHOptions = {
+    /**
+     * - The current working directory.
+     */
+    cwd?: string | undefined;
+    /**
+     * - The environment variables.
+     */
+    env?: any;
+    /**
+     * - The shell to use for execution.
+     */
+    shell?: string | undefined;
+    /**
+     * - The prefix commands to ensure a safe execution environment. e.g: prefix: 'set -euo pipefail;/usr/bin/env',
+     */
+    prefix?: string | undefined;
+    /**
+     * - The stdio configuration.
+     */
+    stdio?: number | "pipe" | "ignore" | "inherit" | StdioOption[] | undefined;
+    /**
+     * - default 20000: a timeout error is triggerd when a process execution time is exceeded, 0 is no timeout
+     */
+    timeout?: number | undefined;
+};
+export type StdioOption = ("pipe" | "ignore" | "inherit" | number);
+export type StdioOptions = Array<StdioOption> | StdioOption;
+declare class SHDispatch {
+    /**
+    * @param {string} cmd - cmd to execute
+    */
+    constructor(cmd: string);
+    /**
+    * @param {SHOptions} options
+    * @returns {SHDispatch}
+    */
+    options(options: SHOptions): SHDispatch;
+    /**
+    * @param {string} [payload]
+    * @returns {Promise<string>}
+    */
+    run(payload?: string | undefined): Promise<string>;
+    /**
+    * Works for screen takeovers like editors
+    * @param {string} [payload]
+    * @returns {SpawnSyncResponse}
+    */
+    runSync(payload?: string | undefined): SpawnSyncResponse;
+    kill(): Promise<void>;
+    #private;
+}

package/types/SHExecute.d.ts

@@ -0,0 +1,23 @@
+export default SHExecute;
+declare class SHExecute {
+    /**
+    * @param {string} command - linux command to be executed
+    * @param {import('./SHDispatch').SHOptions} [options] - ChildProcess options
+    */
+    constructor(command: string, options?: any);
+    /**
+    * @param {string} [payload] - data to write
+    * @retuns {Promise<object>}
+    */
+    runSync(payload?: string | undefined): any;
+    /**
+    * @param {string} [payload] - data to write
+    * @retuns {Promise<string>}
+    */
+    run(payload?: string | undefined): Promise<any>;
+    /**
+    * @returns {Promise<number[]>}
+    */
+    kill(signal?: string): Promise<number[]>;
+    #private;
+}