@socketsecurity/lib 6.0.3 → 6.0.5

package/dist/stdio/_internal.js

@@ -1,57 +1,61 @@
 "use strict";
-/* Socket Lib - Built with esbuild */
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var internal_exports = {};
-__export(internal_exports, {
-  clearLineOn: () => clearLineOn,
-  cursorToOn: () => cursorToOn,
-  getColumnsOf: () => getColumnsOf,
-  getRowsOf: () => getRowsOf,
-  isTTYOf: () => isTTYOf
-});
-module.exports = __toCommonJS(internal_exports);
+/* Socket Lib - Built with rolldown */
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+//#region src/stdio/_internal.ts
+/**
+* @private
+*
+* @file Shared TTY primitives for stdio/stdout.ts + stdio/stderr.ts.
+*/
+/**
+* Clear the current line on the given stream. Only works in TTY environments.
+*
+* @private
+*/
 function clearLineOn(stream) {
-  if (stream.isTTY) {
-    stream.cursorTo(0);
-    stream.clearLine(0);
-  }
+	if (stream.isTTY) {
+		stream.cursorTo(0);
+		stream.clearLine(0);
+	}
 }
+/**
+* Move cursor to specific position on the given stream. Only works in TTY
+* environments.
+*
+* @private
+*/
 function cursorToOn(stream, x, y) {
-  if (stream.isTTY) {
-    stream.cursorTo(x, y);
-  }
+	if (stream.isTTY) stream.cursorTo(x, y);
 }
+/**
+* Get the number of columns on the given stream (or 80 fallback).
+*
+* @private
+*/
 function getColumnsOf(stream) {
-  return stream.columns || 80;
+	return stream.columns || 80;
 }
+/**
+* Get the number of rows on the given stream (or 24 fallback).
+*
+* @private
+*/
 function getRowsOf(stream) {
-  return stream.rows || 24;
+	return stream.rows || 24;
 }
+/**
+* Check if the given stream is connected to a TTY.
+*
+* @private
+*/
 function isTTYOf(stream) {
-  return stream.isTTY || false;
+	return stream.isTTY || false;
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  clearLineOn,
-  cursorToOn,
-  getColumnsOf,
-  getRowsOf,
-  isTTYOf
-});
+
+//#endregion
+exports.clearLineOn = clearLineOn;
+exports.cursorToOn = cursorToOn;
+exports.getColumnsOf = getColumnsOf;
+exports.getRowsOf = getRowsOf;
+exports.isTTYOf = isTTYOf;

package/dist/stdio/clear.js

@@ -1,96 +1,218 @@
 "use strict";
-/* Socket Lib - Built with esbuild */
-"use strict";
-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");
-  }
+/* Socket Lib - Built with rolldown */
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_runtime = require('../_virtual/_rolldown/runtime.js');
+let node_process = require("node:process");
+node_process = require_runtime.__toESM(node_process);
+
+//#region src/stdio/clear.ts
+/**
+* @file Terminal clearing and cursor utilities. Provides functions for clearing
+*   lines, screens, and managing cursor position.
+*/
+/**
+* Clear the current line in the terminal. Uses native TTY methods when
+* available, falls back to ANSI escape codes. Uses native TTY methods when
+* available and falls back to `\r\x1b[K` ANSI escapes on non-TTY streams.
+*
+* ANSI Sequences:
+*
+* - `\r`: Carriage return (move to line start)
+* - `\x1b[K`: Clear from cursor to end of line
+*
+* @example
+*   ;```ts
+*   clearLine() // Clear current line on stdout
+*   clearLine(process.stderr) // Clear on stderr
+*   ```
+*
+* @default stream process.stdout
+*
+* @param stream - Output stream to clear (defaults to `process.stdout`)
+*/
+function clearLine(stream = 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");
-  }
+/**
+* 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
+*
+* @example
+*   ;```ts
+*   console.log('Line 1')
+*   console.log('Line 2')
+*   console.log('Line 3')
+*   clearLines(2) // Clears lines 2 and 3
+*   ```
+*
+* @default stream process.stdout
+*
+* @param count - Number of lines to clear.
+* @param stream - Output stream to clear.
+*/
+function clearLines(count, stream = 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");
-  }
+/**
+* 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)
+*
+* @example
+*   ;```ts
+*   clearScreen() // Clear entire terminal
+*   ```
+*
+* @default stream process.stdout
+*
+* @param stream - Output stream to clear.
+*/
+function clearScreen(stream = node_process.default.stdout) {
+	if (stream.isTTY) stream.write("\x1Bc");
 }
-function clearVisible(stream = import_node_process.default.stdout) {
-  clearScreen(stream);
+/**
+* Clear the visible terminal screen. Alias for `clearScreen()`.
+*
+* @example
+*   ;```ts
+*   clearVisible() // Same as clearScreen()
+*   ```
+*
+* @default stream process.stdout
+*
+* @param stream - Output stream to clear.
+*/
+function clearVisible(stream = node_process.default.stdout) {
+	clearScreen(stream);
 }
-function cursorToStart(stream = import_node_process.default.stdout) {
-  if (stream.isTTY) {
-    stream.cursorTo(0);
-  } else {
-    stream.write("\r");
-  }
+/**
+* Move cursor to the beginning of the current line. Uses native TTY methods
+* when available, falls back to carriage return.
+*
+* @example
+*   ;```ts
+*   process.stdout.write('Some text...')
+*   cursorToStart()
+*   process.stdout.write('New text') // Overwrites from start
+*   ```
+*
+* @default stream process.stdout
+*
+* @param stream - Output stream to manipulate.
+*/
+function cursorToStart(stream = 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");
+/**
+* Hide the terminal cursor. Useful for cleaner output during animations or
+* progress indicators.
+*
+* ANSI Sequence:
+*
+* - `\x1b[?25l`: DECTCEM hide cursor
+*
+* @example
+*   ;```ts
+*   hideCursor()
+*   // ... show animation
+*   showCursor()
+*   ```
+*
+* @default stream process.stdout
+*
+* @param stream - Output stream to manipulate.
+*/
+function hideCursor(stream = node_process.default.stdout) {
+	stream.write("\x1B[?25l");
 }
-function restoreCursor(stream = import_node_process.default.stdout) {
-  stream.write("\x1B8");
+/**
+* Restore cursor to previously saved position. Must be called after
+* `saveCursor()`.
+*
+* ANSI Sequence:
+*
+* - `\x1b8`: DECRC restore cursor
+*
+* @example
+*   ;```ts
+*   saveCursor()
+*   console.log('Temporary text')
+*   restoreCursor()
+*   console.log('Back at saved position')
+*   ```
+*
+* @default stream process.stdout
+*
+* @param stream - Output stream to manipulate.
+*/
+function restoreCursor(stream = node_process.default.stdout) {
+	stream.write("\x1B8");
 }
-function saveCursor(stream = import_node_process.default.stdout) {
-  stream.write("\x1B7");
+/**
+* Save the current cursor position. Can be restored later with
+* `restoreCursor()`.
+*
+* ANSI Sequence:
+*
+* - `\x1b7`: DECSC save cursor
+*
+* @example
+*   ;```ts
+*   saveCursor()
+*   console.log('Temporary text')
+*   restoreCursor()
+*   console.log('Back at saved position')
+*   ```
+*
+* @default stream process.stdout
+*
+* @param stream - Output stream to manipulate.
+*/
+function saveCursor(stream = node_process.default.stdout) {
+	stream.write("\x1B7");
 }
-function showCursor(stream = import_node_process.default.stdout) {
-  stream.write("\x1B[?25h");
+/**
+* Show the terminal cursor. Should be called after `hideCursor()` to restore
+* normal cursor visibility.
+*
+* ANSI Sequence:
+*
+* - `\x1b[?25h`: DECTCEM show cursor
+*
+* @example
+*   ;```ts
+*   hideCursor()
+*   // ... show animation
+*   showCursor()
+*   ```
+*
+* @default stream process.stdout
+*
+* @param stream - Output stream to manipulate.
+*/
+function showCursor(stream = node_process.default.stdout) {
+	stream.write("\x1B[?25h");
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  clearLine,
-  clearLines,
-  clearScreen,
-  clearVisible,
-  cursorToStart,
-  hideCursor,
-  restoreCursor,
-  saveCursor,
-  showCursor
-});
+
+//#endregion
+exports.clearLine = clearLine;
+exports.clearLines = clearLines;
+exports.clearScreen = clearScreen;
+exports.clearVisible = clearVisible;
+exports.cursorToStart = cursorToStart;
+exports.hideCursor = hideCursor;
+exports.restoreCursor = restoreCursor;
+exports.saveCursor = saveCursor;
+exports.showCursor = showCursor;