@socketsecurity/lib 6.0.3 → 6.0.5

package/dist/stdio/divider.js

@@ -1,114 +1,187 @@
 "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 divider_exports = {};
-__export(divider_exports, {
-  divider: () => divider,
-  dividers: () => dividers,
-  printDivider: () => printDivider,
-  printDottedDivider: () => printDottedDivider,
-  printSectionBreak: () => printSectionBreak,
-  printThickDivider: () => printThickDivider,
-  printThinDivider: () => printThinDivider,
-  sectionBreak: () => sectionBreak
-});
-module.exports = __toCommonJS(divider_exports);
-var import_default = require("../logger/default");
-var import_format = require("../strings/format");
-const logger = (0, import_default.getDefaultLogger)();
+/* Socket Lib - Built with rolldown */
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_strings_format = require('../strings/format.js');
+const require_logger_default = require('../logger/default.js');
+
+//#region src/stdio/divider.ts
+/**
+* @file Console divider and separator utilities. Provides various line styles
+*   for visual separation in CLI output.
+*/
+const logger = require_logger_default.getDefaultLogger();
+/**
+* Create a divider line with custom character and width. Returns a string of
+* repeated characters for visual separation.
+*
+* @example
+*   ;```ts
+*   console.log(divider()) // Default: 55 '═' characters
+*   console.log(divider({ char: '-', width: 40 }))
+*   console.log(divider({ char: '·', width: 30 }))
+*   ```
+*
+* @param options - Divider formatting options.
+*
+* @returns Divider string
+*/
 function divider(options) {
-  const opts = { __proto__: null, ...options };
-  const { char = "\u2550", width = 55 } = opts;
-  return (0, import_format.repeatString)(char, width);
+	const { char = "═", width = 55 } = {
+		__proto__: null,
+		...options
+	};
+	return /* @__PURE__ */ require_strings_format.repeatString(char, width);
 }
+/**
+* Common divider style presets. Provides quick access to popular divider
+* styles.
+*
+* @example
+*   ;```ts
+*   console.log(dividers.thick()) // ═══════...
+*   console.log(dividers.thin()) // ───────...
+*   console.log(dividers.dotted()) // ·······...
+*   ```
+*/
 const dividers = {
-  /**
-   * Thick double-line divider using `═`
-   */
-  thick: () => divider({ char: "\u2550" }),
-  /**
-   * Thin single-line divider using `─`
-   */
-  thin: () => divider({ char: "\u2500" }),
-  /**
-   * Double-line divider (alias for thick)
-   */
-  double: () => divider({ char: "\u2550" }),
-  /**
-   * Simple single dash divider using `-`
-   */
-  single: () => divider({ char: "-" }),
-  /**
-   * Dotted divider using `·`
-   */
-  dotted: () => divider({ char: "\xB7" }),
-  /**
-   * Dashed divider using `╌`
-   */
-  dashed: () => divider({ char: "\u254C" }),
-  /**
-   * Wave divider using `~`
-   */
-  wave: () => divider({ char: "~" }),
-  /**
-   * Star divider using `*`
-   */
-  star: () => divider({ char: "*" }),
-  /**
-   * Diamond divider using `◆`
-   */
-  diamond: () => divider({ char: "\u25C6" }),
-  /**
-   * Arrow divider using `→`
-   */
-  arrow: () => divider({ char: "\u2192" })
+	/**
+	* Thick double-line divider using `═`
+	*/
+	thick: () => divider({ char: "═" }),
+	/**
+	* Thin single-line divider using `─`
+	*/
+	thin: () => divider({ char: "─" }),
+	/**
+	* Double-line divider (alias for thick)
+	*/
+	double: () => divider({ char: "═" }),
+	/**
+	* Simple single dash divider using `-`
+	*/
+	single: () => divider({ char: "-" }),
+	/**
+	* Dotted divider using `·`
+	*/
+	dotted: () => divider({ char: "·" }),
+	/**
+	* Dashed divider using `╌`
+	*/
+	dashed: () => divider({ char: "╌" }),
+	/**
+	* Wave divider using `~`
+	*/
+	wave: () => divider({ char: "~" }),
+	/**
+	* Star divider using `*`
+	*/
+	star: () => divider({ char: "*" }),
+	/**
+	* Diamond divider using `◆`
+	*/
+	diamond: () => divider({ char: "◆" }),
+	/**
+	* Arrow divider using `→`
+	*/
+	arrow: () => divider({ char: "→" })
 };
+/**
+* Print a divider line directly to console.
+*
+* @example
+*   ;```ts
+*   printDivider() // Prints default divider
+*   printDivider({ char: '─', width: 60 })
+*   ```
+*
+* @param options - Divider formatting options.
+*/
 function printDivider(options) {
-  logger.log(divider(options));
+	logger.log(divider(options));
 }
+/**
+* Print a dotted divider line. Convenience function using `·` character.
+*
+* @example
+*   ;```ts
+*   printDottedDivider()
+*   // ·······················································
+*   ```
+*/
 function printDottedDivider() {
-  printDivider({ char: "\xB7" });
+	printDivider({ char: "·" });
 }
+/**
+* Print a section break with spacing directly to console.
+*
+* @example
+*   ;```ts
+*   console.log('Previous section')
+*   printSectionBreak()
+*   console.log('Next section')
+*   ```
+*
+* @param options - Divider formatting options.
+*/
 function printSectionBreak(options) {
-  logger.log(sectionBreak(options));
+	logger.log(sectionBreak(options));
 }
+/**
+* Print a thick divider line (default style). Convenience function using `═`
+* character.
+*
+* @example
+*   ;```ts
+*   printThickDivider()
+*   // ═══════════════════════════════════════════════════
+*   ```
+*/
 function printThickDivider() {
-  printDivider({ char: "\u2550" });
+	printDivider({ char: "═" });
 }
+/**
+* Print a thin divider line. Convenience function using `─` character.
+*
+* @example
+*   ;```ts
+*   printThinDivider()
+*   // ───────────────────────────────────────────────────
+*   ```
+*/
 function printThinDivider() {
-  printDivider({ char: "\u2500" });
+	printDivider({ char: "─" });
 }
+/**
+* Create a section break with blank lines before and after the divider. Useful
+* for creating visual separation between major sections.
+*
+* @example
+*   ;```ts
+*   console.log('Previous section')
+*   console.log(sectionBreak())
+*   console.log('Next section')
+*   // Output:
+*   // Previous section
+*   //
+*   // ═══════════════════════════════════════════════════
+*   //
+*   // Next section
+*   ```
+*
+* @param options - Divider formatting options.
+*
+* @returns Section break string with newlines
+*/
 function sectionBreak(options) {
-  const div = divider(options);
-  return `
-${div}
-`;
+	return `\n${divider(options)}\n`;
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  divider,
-  dividers,
-  printDivider,
-  printDottedDivider,
-  printSectionBreak,
-  printThickDivider,
-  printThinDivider,
-  sectionBreak
-});
+
+//#endregion
+exports.divider = divider;
+exports.dividers = dividers;
+exports.printDivider = printDivider;
+exports.printDottedDivider = printDottedDivider;
+exports.printSectionBreak = printSectionBreak;
+exports.printThickDivider = printThickDivider;
+exports.printThinDivider = printThinDivider;
+exports.sectionBreak = sectionBreak;

package/dist/stdio/footer.js

@@ -1,117 +1,123 @@
 "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 footer_exports = {};
-__export(footer_exports, {
-  createFooter: () => createFooter,
-  createSummaryFooter: () => createSummaryFooter,
-  printFooter: () => printFooter
-});
-module.exports = __toCommonJS(footer_exports);
-var import_yoctocolors_cjs = __toESM(require("../external/yoctocolors-cjs"));
-var import_format = require("../strings/format");
-var import_array = require("../primordials/array");
-var import_default = require("../logger/default");
-var import_symbols = require("../logger/symbols");
-var import_date = require("../primordials/date");
-const logger = (0, import_default.getDefaultLogger)();
+/* Socket Lib - Built with rolldown */
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_runtime = require('../_virtual/_rolldown/runtime.js');
+const require_primordials_array = require('../primordials/array.js');
+const require_primordials_date = require('../primordials/date.js');
+const require_strings_format = require('../strings/format.js');
+const require_logger_symbols = require('../logger/symbols.js');
+const require_logger_default = require('../logger/default.js');
+let src_external_yoctocolors_cjs = require("../external/yoctocolors-cjs");
+src_external_yoctocolors_cjs = require_runtime.__toESM(src_external_yoctocolors_cjs);
+
+//#region src/stdio/footer.ts
+/**
+* @file Console footer/summary formatting utilities. Provides consistent footer
+*   and summary formatting for CLI applications.
+*/
+const logger = require_logger_default.getDefaultLogger();
+/**
+* Create a formatted footer with optional message, timestamp, and duration.
+* Useful for marking the end of CLI output or showing completion status.
+*
+* @example
+*   ;```ts
+*   const startTime = Date.now()
+*   // ... do work
+*   console.log(
+*     createFooter('Build complete', {
+*       width: 60,
+*       color: 'green',
+*       showDuration: true,
+*       startTime,
+*     }),
+*   )
+*   ```
+*
+* @param message - Optional message to display in footer.
+* @param options - Footer formatting options.
+*
+* @returns Formatted footer string with border and optional info
+*/
 function createFooter(message, options) {
-  const {
-    borderChar = "=",
-    color = "gray",
-    showDuration = false,
-    showTimestamp = false,
-    startTime,
-    width = 80
-  } = { __proto__: null, ...options };
-  const border = (0, import_format.repeatString)(borderChar, width);
-  const lines = [];
-  if (message) {
-    const colorFn = color && import_yoctocolors_cjs.default[color] ? import_yoctocolors_cjs.default[color] : (s) => s;
-    (0, import_array.ArrayPrototypePush)(lines, colorFn(message));
-  }
-  if (showTimestamp) {
-    const timestamp = new import_date.DateCtor().toISOString();
-    (0, import_array.ArrayPrototypePush)(lines, import_yoctocolors_cjs.default.gray(`Completed at: ${timestamp}`));
-  }
-  if (showDuration && startTime) {
-    const duration = (0, import_date.DateNow)() - startTime;
-    const seconds = (duration / 1e3).toFixed(2);
-    (0, import_array.ArrayPrototypePush)(lines, import_yoctocolors_cjs.default.gray(`Duration: ${seconds}s`));
-  }
-  (0, import_array.ArrayPrototypePush)(lines, border);
-  return lines.join("\n");
+	const { borderChar = "=", color = "gray", showDuration = false, showTimestamp = false, startTime, width = 80 } = {
+		__proto__: null,
+		...options
+	};
+	const border = /* @__PURE__ */ require_strings_format.repeatString(borderChar, width);
+	const lines = [];
+	if (message) require_primordials_array.ArrayPrototypePush(lines, (color && src_external_yoctocolors_cjs.default[color] ? src_external_yoctocolors_cjs.default[color] : (s) => s)(message));
+	if (showTimestamp) {
+		const timestamp = new require_primordials_date.DateCtor().toISOString();
+		require_primordials_array.ArrayPrototypePush(lines, src_external_yoctocolors_cjs.default.gray(`Completed at: ${timestamp}`));
+	}
+	if (showDuration && startTime) {
+		const seconds = ((require_primordials_date.DateNow() - startTime) / 1e3).toFixed(2);
+		require_primordials_array.ArrayPrototypePush(lines, src_external_yoctocolors_cjs.default.gray(`Duration: ${seconds}s`));
+	}
+	require_primordials_array.ArrayPrototypePush(lines, border);
+	return lines.join("\n");
 }
+/**
+* Create a summary footer with statistics and colored status indicators.
+* Automatically formats success/failure/warning counts with appropriate colors.
+* Useful for test results, build summaries, or batch operation reports.
+*
+* @example
+*   ;```ts
+*   console.log(
+*     createSummaryFooter({
+*       total: 150,
+*       success: 145,
+*       failed: 3,
+*       skipped: 2,
+*       warnings: 5,
+*     }),
+*   )
+*   // Output: Total: 150 | ✓ 145 passed | ✗ 3 failed | ○ 2 skipped | ⚠ 5 warnings
+*   // ========================================
+*   ```
+*
+* @param stats - Statistics to display in the summary.
+* @param options - Footer formatting options.
+*
+* @returns Formatted summary footer string with colored indicators
+*/
 function createSummaryFooter(stats, options) {
-  const parts = [];
-  if (stats.total !== void 0) {
-    (0, import_array.ArrayPrototypePush)(parts, `Total: ${stats.total}`);
-  }
-  if (stats.success !== void 0) {
-    (0, import_array.ArrayPrototypePush)(
-      parts,
-      `${import_symbols.LOG_SYMBOLS["success"]} ${stats.success} passed`
-    );
-  }
-  if (stats.failed !== void 0 && stats.failed > 0) {
-    (0, import_array.ArrayPrototypePush)(parts, `${import_symbols.LOG_SYMBOLS["fail"]} ${stats.failed} failed`);
-  }
-  if (stats.skipped !== void 0 && stats.skipped > 0) {
-    (0, import_array.ArrayPrototypePush)(parts, `${import_symbols.LOG_SYMBOLS["skip"]} ${stats.skipped} skipped`);
-  }
-  if (stats.warnings !== void 0 && stats.warnings > 0) {
-    (0, import_array.ArrayPrototypePush)(
-      parts,
-      `${import_symbols.LOG_SYMBOLS["warn"]} ${stats.warnings} warnings`
-    );
-  }
-  if (stats.errors !== void 0 && stats.errors > 0) {
-    (0, import_array.ArrayPrototypePush)(parts, `${import_symbols.LOG_SYMBOLS["fail"]} ${stats.errors} errors`);
-  }
-  const message = parts.join(" | ");
-  return createFooter(message, {
-    ...options,
-    showDuration: stats.duration !== void 0,
-    ...stats.duration !== void 0 && { startTime: stats.duration }
-  });
+	const parts = [];
+	if (stats.total !== void 0) require_primordials_array.ArrayPrototypePush(parts, `Total: ${stats.total}`);
+	if (stats.success !== void 0) require_primordials_array.ArrayPrototypePush(parts, `${require_logger_symbols.LOG_SYMBOLS["success"]} ${stats.success} passed`);
+	if (stats.failed !== void 0 && stats.failed > 0) require_primordials_array.ArrayPrototypePush(parts, `${require_logger_symbols.LOG_SYMBOLS["fail"]} ${stats.failed} failed`);
+	if (stats.skipped !== void 0 && stats.skipped > 0) require_primordials_array.ArrayPrototypePush(parts, `${require_logger_symbols.LOG_SYMBOLS["skip"]} ${stats.skipped} skipped`);
+	if (stats.warnings !== void 0 && stats.warnings > 0) require_primordials_array.ArrayPrototypePush(parts, `${require_logger_symbols.LOG_SYMBOLS["warn"]} ${stats.warnings} warnings`);
+	if (stats.errors !== void 0 && stats.errors > 0) require_primordials_array.ArrayPrototypePush(parts, `${require_logger_symbols.LOG_SYMBOLS["fail"]} ${stats.errors} errors`);
+	return createFooter(parts.join(" | "), {
+		...options,
+		showDuration: stats.duration !== void 0,
+		...stats.duration !== void 0 && { startTime: stats.duration }
+	});
 }
+/**
+* Print a footer with optional success message. Uses `─` border character for a
+* lighter appearance. Fixed width of 55 characters to match `printHeader()`.
+*
+* @example
+*   ;```ts
+*   printFooter('Analysis complete')
+*   // Output:
+*   // ───────────────────────────────────────────────────
+*   // Analysis complete (in green)
+*   ```
+*
+* @param message - Optional message to display (shown in green)
+*/
 function printFooter(message) {
-  const border = (0, import_format.repeatString)("\u2500", 55);
-  logger.log(border);
-  if (message) {
-    logger.log(import_yoctocolors_cjs.default.green(message));
-  }
+	const border = /* @__PURE__ */ require_strings_format.repeatString("─", 55);
+	logger.log(border);
+	if (message) logger.log(src_external_yoctocolors_cjs.default.green(message));
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  createFooter,
-  createSummaryFooter,
-  printFooter
-});
+
+//#endregion
+exports.createFooter = createFooter;
+exports.createSummaryFooter = createSummaryFooter;
+exports.printFooter = printFooter;