@socketsecurity/lib 5.18.2 → 5.19.0

package/dist/stdio/clear.d.ts

@@ -1,140 +0,0 @@
-export declare function clearLine(stream?: NodeJS.WriteStream): void;
-/**
- * Clear multiple lines above the current cursor position.
- * Useful for clearing multi-line output like progress bars or status messages.
- *
- * ANSI Sequences:
- * - `\x1b[1A`: Move cursor up one line
- * - `\x1b[2K`: Erase entire line
- *
- * @param count - Number of lines to clear
- * @param stream - Output stream to clear
- * @default stream process.stdout
- *
- * @example
- * ```ts
- * console.log('Line 1')
- * console.log('Line 2')
- * console.log('Line 3')
- * clearLines(2) // Clears lines 2 and 3
- * ```
- */
-export declare function clearLines(count: number, stream?: NodeJS.WriteStream): void;
-/**
- * Clear the entire screen and reset cursor to top-left.
- * Only works in TTY environments.
- *
- * ANSI Sequence:
- * - `\x1bc`: Full reset (clear screen and move cursor home)
- *
- * @param stream - Output stream to clear
- * @default stream process.stdout
- *
- * @example
- * ```ts
- * clearScreen() // Clear entire terminal
- * ```
- */
-export declare function clearScreen(stream?: NodeJS.WriteStream): void;
-/**
- * Clear the visible terminal screen.
- * Alias for `clearScreen()`.
- *
- * @param stream - Output stream to clear
- * @default stream process.stdout
- *
- * @example
- * ```ts
- * clearVisible() // Same as clearScreen()
- * ```
- */
-export declare function clearVisible(stream?: NodeJS.WriteStream): void;
-/**
- * Move cursor to the beginning of the current line.
- * Uses native TTY methods when available, falls back to carriage return.
- *
- * @param stream - Output stream to manipulate
- * @default stream process.stdout
- *
- * @example
- * ```ts
- * process.stdout.write('Some text...')
- * cursorToStart()
- * process.stdout.write('New text') // Overwrites from start
- * ```
- */
-export declare function cursorToStart(stream?: NodeJS.WriteStream): void;
-/**
- * Hide the terminal cursor.
- * Useful for cleaner output during animations or progress indicators.
- *
- * ANSI Sequence:
- * - `\x1b[?25l`: DECTCEM hide cursor
- *
- * @param stream - Output stream to manipulate
- * @default stream process.stdout
- *
- * @example
- * ```ts
- * hideCursor()
- * // ... show animation
- * showCursor()
- * ```
- */
-export declare function hideCursor(stream?: NodeJS.WriteStream): void;
-/**
- * Show the terminal cursor.
- * Should be called after `hideCursor()` to restore normal cursor visibility.
- *
- * ANSI Sequence:
- * - `\x1b[?25h`: DECTCEM show cursor
- *
- * @param stream - Output stream to manipulate
- * @default stream process.stdout
- *
- * @example
- * ```ts
- * hideCursor()
- * // ... show animation
- * showCursor()
- * ```
- */
-export declare function showCursor(stream?: NodeJS.WriteStream): void;
-/**
- * Save the current cursor position.
- * Can be restored later with `restoreCursor()`.
- *
- * ANSI Sequence:
- * - `\x1b7`: DECSC save cursor
- *
- * @param stream - Output stream to manipulate
- * @default stream process.stdout
- *
- * @example
- * ```ts
- * saveCursor()
- * console.log('Temporary text')
- * restoreCursor()
- * console.log('Back at saved position')
- * ```
- */
-export declare function saveCursor(stream?: NodeJS.WriteStream): void;
-/**
- * Restore cursor to previously saved position.
- * Must be called after `saveCursor()`.
- *
- * ANSI Sequence:
- * - `\x1b8`: DECRC restore cursor
- *
- * @param stream - Output stream to manipulate
- * @default stream process.stdout
- *
- * @example
- * ```ts
- * saveCursor()
- * console.log('Temporary text')
- * restoreCursor()
- * console.log('Back at saved position')
- * ```
- */
-export declare function restoreCursor(stream?: NodeJS.WriteStream): void;

package/dist/stdio/clear.js

@@ -1,95 +0,0 @@
-"use strict";
-/* Socket Lib - Built with esbuild */
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var clear_exports = {};
-__export(clear_exports, {
-  clearLine: () => clearLine,
-  clearLines: () => clearLines,
-  clearScreen: () => clearScreen,
-  clearVisible: () => clearVisible,
-  cursorToStart: () => cursorToStart,
-  hideCursor: () => hideCursor,
-  restoreCursor: () => restoreCursor,
-  saveCursor: () => saveCursor,
-  showCursor: () => showCursor
-});
-module.exports = __toCommonJS(clear_exports);
-var import_node_process = __toESM(require("node:process"));
-function clearLine(stream = import_node_process.default.stdout) {
-  if (stream.isTTY) {
-    stream.cursorTo(0);
-    stream.clearLine(0);
-  } else {
-    stream.write("\r\x1B[K");
-  }
-}
-function clearLines(count, stream = import_node_process.default.stdout) {
-  for (let i = 0; i < count; i++) {
-    stream.write("\x1B[1A\x1B[2K");
-  }
-}
-function clearScreen(stream = import_node_process.default.stdout) {
-  if (stream.isTTY) {
-    stream.write("\x1Bc");
-  }
-}
-function clearVisible(stream = import_node_process.default.stdout) {
-  clearScreen(stream);
-}
-function cursorToStart(stream = import_node_process.default.stdout) {
-  if (stream.isTTY) {
-    stream.cursorTo(0);
-  } else {
-    stream.write("\r");
-  }
-}
-function hideCursor(stream = import_node_process.default.stdout) {
-  stream.write("\x1B[?25l");
-}
-function showCursor(stream = import_node_process.default.stdout) {
-  stream.write("\x1B[?25h");
-}
-function saveCursor(stream = import_node_process.default.stdout) {
-  stream.write("\x1B7");
-}
-function restoreCursor(stream = import_node_process.default.stdout) {
-  stream.write("\x1B8");
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  clearLine,
-  clearLines,
-  clearScreen,
-  clearVisible,
-  cursorToStart,
-  hideCursor,
-  restoreCursor,
-  saveCursor,
-  showCursor
-});

package/dist/stdio/mask.d.ts

@@ -1,151 +0,0 @@
-import type { ChildProcess, SpawnOptions } from 'child_process';
-export interface OutputMaskOptions {
-    /**
-     * Current working directory for spawned process.
-     * @default process.cwd()
-     */
-    cwd?: string | undefined;
-    /**
-     * Environment variables for spawned process.
-     * @default process.env
-     */
-    env?: NodeJS.ProcessEnv | undefined;
-    /**
-     * Filter output before displaying or buffering.
-     * Return `false` to skip the line, `true` to include it.
-     *
-     * Useful for filtering non-fatal warnings or noise from test runners.
-     * The filter runs on every chunk of output before display/buffering.
-     *
-     * @param text - The output text chunk (may include ANSI codes)
-     * @param stream - Whether this came from 'stdout' or 'stderr'
-     * @returns `true` to include this output, `false` to skip it
-     *
-     * @example
-     * ```ts
-     * filterOutput: (text, stream) => {
-     *   // Skip vitest worker termination errors
-     *   if (text.includes('Terminating worker thread')) return false
-     *   return true
-     * }
-     * ```
-     */
-    filterOutput?: ((text: string, stream: 'stdout' | 'stderr') => boolean) | undefined;
-    /**
-     * Progress message to display in spinner.
-     * @default 'Running…'
-     */
-    message?: string | undefined;
-    /**
-     * Override the exit code based on captured output.
-     *
-     * Useful for handling non-fatal errors that shouldn't fail the build.
-     * Called after the process exits with the original code and all captured output.
-     * Return a number to override the exit code, or `undefined` to keep original.
-     *
-     * @param code - Original exit code from the process
-     * @param stdout - All captured stdout (even filtered lines are captured)
-     * @param stderr - All captured stderr (even filtered lines are captured)
-     * @returns New exit code, or `undefined` to keep original
-     *
-     * @example
-     * ```ts
-     * overrideExitCode: (code, stdout, stderr) => {
-     *   // If only worker termination errors, treat as success
-     *   const output = stdout + stderr
-     *   const hasWorkerError = output.includes('Terminating worker thread')
-     *   const hasRealFailure = output.includes('FAIL')
-     *   if (code !== 0 && hasWorkerError && !hasRealFailure) {
-     *     return 0 // Override to success
-     *   }
-     *   return undefined // Keep original
-     * }
-     * ```
-     */
-    overrideExitCode?: ((code: number, stdout: string, stderr: string) => number | undefined) | undefined;
-    /**
-     * Start with output visible instead of masked.
-     * When `true`, output shows immediately without needing ctrl+o.
-     * @default false
-     */
-    showOutput?: boolean | undefined;
-    /**
-     * Text to show after "ctrl+o" in spinner message.
-     * @default 'to see full output'
-     */
-    toggleText?: string | undefined;
-}
-export interface OutputMask {
-    /** Whether spinner is currently active */
-    isSpinning: boolean;
-    /** Buffered output lines */
-    outputBuffer: string[];
-    /** All stderr captured (for exit code override) */
-    stderrCapture: string;
-    /** All stdout captured (for exit code override) */
-    stdoutCapture: string;
-    /** Whether output is currently visible */
-    verbose: boolean;
-}
-/**
- * Create an output mask for controlling command output visibility.
- * The mask tracks whether output should be shown or hidden (buffered).
- * When hidden, output is buffered and a spinner is shown instead.
- *
- * @example
- * ```typescript
- * const mask = createOutputMask({ showOutput: false })
- * console.log(mask.verbose)  // false
- * ```
- */
-export declare function createOutputMask(options?: OutputMaskOptions): OutputMask;
-/**
- * Create a keyboard handler for toggling output visibility.
- * Handles two key combinations:
- * - ctrl+o: Toggle between showing and hiding output.
- * - ctrl+c: Cancel the running process.
- * The handler manipulates terminal state using ANSI escape sequences.
- *
- * @example
- * ```typescript
- * const handler = createKeyboardHandler(mask, childProcess, {
- *   message: 'Testing...',
- * })
- * ```
- */
-type ReadlineKey = {
-    ctrl?: boolean;
-    name?: string;
-};
-export declare function createKeyboardHandler(mask: OutputMask, child: ChildProcess, options?: OutputMaskOptions): (_str: string, key: ReadlineKey) => void;
-/**
- * Attach output masking to a child process.
- * Returns a promise that resolves with the exit code.
- * This function:
- * - Sets up keyboard input handling in raw mode for immediate key capture.
- * - Buffers stdout/stderr when not in verbose mode.
- * - Shows a spinner when output is masked.
- * - Allows toggling between masked and unmasked output with ctrl+o.
- *
- * @example
- * ```typescript
- * const child = spawn("pnpm", ["test"], { stdio: ["inherit", "pipe", "pipe"] })
- * const exitCode = await attachOutputMask(child, { message: 'Running tests' })
- * ```
- */
-export declare function attachOutputMask(child: ChildProcess, options?: OutputMaskOptions): Promise<number>;
-/**
- * Run a command with interactive output masking.
- * Convenience wrapper around spawn + attachOutputMask.
- * Spawns a child process and attaches the output masking system to it.
- * stdin is inherited, stdout and stderr are piped for masking control.
- *
- * @example
- * ```typescript
- * const exitCode = await runWithMask('pnpm', ['test'], {
- *   message: 'Running tests',
- * })
- * ```
- */
-export declare function runWithMask(command: string, args?: string[], options?: OutputMaskOptions & SpawnOptions): Promise<number>;
-export {};

package/dist/stdio/mask.js

@@ -1,224 +0,0 @@
-"use strict";
-/* Socket Lib - Built with esbuild */
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var mask_exports = {};
-__export(mask_exports, {
-  attachOutputMask: () => attachOutputMask,
-  createKeyboardHandler: () => createKeyboardHandler,
-  createOutputMask: () => createOutputMask,
-  runWithMask: () => runWithMask
-});
-module.exports = __toCommonJS(mask_exports);
-var import_node_process = __toESM(require("node:process"));
-var import_spinner = require("../spinner.js");
-var import_clear = require("./clear.js");
-var import_stdout = require("./stdout.js");
-let _child_process;
-// @__NO_SIDE_EFFECTS__
-function getChildProcess() {
-  if (_child_process === void 0) {
-    _child_process = require("child_process");
-  }
-  return _child_process;
-}
-let _readline;
-// @__NO_SIDE_EFFECTS__
-function getReadline() {
-  if (_readline === void 0) {
-    _readline = require("readline");
-  }
-  return _readline;
-}
-const spinner = (0, import_spinner.getDefaultSpinner)();
-function createOutputMask(options = {}) {
-  const { showOutput = false } = options;
-  return {
-    isSpinning: !showOutput,
-    outputBuffer: [],
-    stderrCapture: "",
-    stdoutCapture: "",
-    verbose: showOutput
-  };
-}
-function createKeyboardHandler(mask, child, options = {}) {
-  const { message = "Running\u2026", toggleText = "to see full output" } = options;
-  return (_str, key) => {
-    if (key?.ctrl && key.name === "o") {
-      mask.verbose = !mask.verbose;
-      if (mask.verbose) {
-        if (mask.isSpinning) {
-          spinner.stop();
-          mask.isSpinning = false;
-        }
-        (0, import_clear.clearLine)();
-        if (mask.outputBuffer.length > 0) {
-          console.log("--- Output (ctrl+o to hide) ---");
-          mask.outputBuffer.forEach((line) => {
-            (0, import_stdout.write)(line);
-          });
-        }
-      } else {
-        if (mask.outputBuffer.length > 0) {
-          const lineCount = mask.outputBuffer.join("").split("\n").length + 1;
-          for (let i = 0; i < lineCount; i += 1) {
-            import_node_process.default.stdout.write("\x1B[1A\x1B[2K");
-          }
-        }
-        (0, import_clear.clearLine)();
-        mask.outputBuffer = [];
-        if (!mask.isSpinning) {
-          spinner.start(`${message} (ctrl+o ${toggleText})`);
-          mask.isSpinning = true;
-        }
-      }
-    } else if (key?.ctrl && key.name === "c") {
-      child.kill("SIGTERM");
-      if (import_node_process.default.stdin.isTTY) {
-        import_node_process.default.stdin.setRawMode(false);
-      }
-      throw new Error("Process cancelled by user");
-    }
-  };
-}
-function attachOutputMask(child, options = {}) {
-  return new Promise((resolve, reject) => {
-    const { message = "Running\u2026" } = options;
-    const mask = createOutputMask(options);
-    if (mask.isSpinning && import_node_process.default.stdout.isTTY) {
-      spinner.start(
-        `${message} (ctrl+o ${options.toggleText || "to see full output"})`
-      );
-    }
-    if (import_node_process.default.stdin.isTTY) {
-      (/* @__PURE__ */ getReadline()).emitKeypressEvents(import_node_process.default.stdin);
-      import_node_process.default.stdin.setRawMode(true);
-      const keypressHandler = createKeyboardHandler(mask, child, options);
-      import_node_process.default.stdin.on("keypress", keypressHandler);
-      child.on("exit", () => {
-        if (import_node_process.default.stdin.isTTY) {
-          import_node_process.default.stdin.setRawMode(false);
-          import_node_process.default.stdin.removeListener("keypress", keypressHandler);
-        }
-      });
-    }
-    if (child.stdout) {
-      child.stdout.on("data", (data) => {
-        const text = data.toString();
-        mask.stdoutCapture += text;
-        if (options.filterOutput && !options.filterOutput(text, "stdout")) {
-          return void 0;
-        }
-        if (mask.verbose) {
-          (0, import_stdout.write)(text);
-        } else {
-          mask.outputBuffer.push(text);
-          const lines = mask.outputBuffer.join("").split("\n");
-          if (lines.length > 1e3) {
-            mask.outputBuffer = [lines.slice(-1e3).join("\n")];
-          }
-        }
-        return void 0;
-      });
-    }
-    if (child.stderr) {
-      child.stderr.on("data", (data) => {
-        const text = data.toString();
-        mask.stderrCapture += text;
-        if (options.filterOutput && !options.filterOutput(text, "stderr")) {
-          return void 0;
-        }
-        if (mask.verbose) {
-          import_node_process.default.stderr.write(text);
-        } else {
-          mask.outputBuffer.push(text);
-        }
-        return void 0;
-      });
-    }
-    child.on("exit", (code) => {
-      if (import_node_process.default.stdin.isTTY) {
-        import_node_process.default.stdin.setRawMode(false);
-      }
-      let finalCode = code || 0;
-      if (options.overrideExitCode) {
-        const overridden = options.overrideExitCode(
-          finalCode,
-          mask.stdoutCapture,
-          mask.stderrCapture
-        );
-        if (overridden !== void 0) {
-          finalCode = overridden;
-        }
-      }
-      if (mask.isSpinning) {
-        if (finalCode === 0) {
-          spinner.successAndStop(`${message} completed`);
-        } else {
-          spinner.failAndStop(`${message} failed`);
-          if (mask.outputBuffer.length > 0 && !mask.verbose) {
-            console.log("\n--- Output ---");
-            mask.outputBuffer.forEach((line) => {
-              (0, import_stdout.write)(line);
-            });
-          }
-        }
-      }
-      resolve(finalCode);
-    });
-    child.on("error", (error) => {
-      if (import_node_process.default.stdin.isTTY) {
-        import_node_process.default.stdin.setRawMode(false);
-      }
-      if (mask.isSpinning) {
-        spinner.failAndStop(`${message} error`);
-      }
-      reject(error);
-    });
-  });
-}
-async function runWithMask(command, args = [], options = {}) {
-  const {
-    message = "Running\u2026",
-    showOutput = false,
-    toggleText = "to see output",
-    ...spawnOptions
-  } = options;
-  const child = (/* @__PURE__ */ getChildProcess()).spawn(command, args, {
-    stdio: ["inherit", "pipe", "pipe"],
-    ...spawnOptions
-  });
-  return await attachOutputMask(child, { message, showOutput, toggleText });
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  attachOutputMask,
-  createKeyboardHandler,
-  createOutputMask,
-  runWithMask
-});