@socketsecurity/lib 5.18.1 → 5.19.0

package/dist/stdio/progress.d.ts

@@ -1,148 +0,0 @@
-export interface ProgressBarOptions {
-    /**
-     * Width of the progress bar in characters.
-     * @default 40
-     */
-    width?: number | undefined;
-    /**
-     * Format template for progress bar display.
-     * Available tokens: `:bar`, `:percent`, `:current`, `:total`, `:elapsed`, `:eta`.
-     * Custom tokens can be passed via the `tokens` parameter in `update()` or `tick()`.
-     * @default ':bar :percent :current/:total'
-     * @example
-     * ```ts
-     * format: ':bar :percent :current/:total :eta'
-     * ```
-     */
-    format?: string | undefined;
-    /**
-     * Character(s) to use for completed portion of bar.
-     * @default '█'
-     */
-    complete?: string | undefined;
-    /**
-     * Character(s) to use for incomplete portion of bar.
-     * @default '░'
-     */
-    incomplete?: string | undefined;
-    /**
-     * Character(s) to use for the head of the progress bar.
-     * @default ''
-     */
-    head?: string | undefined;
-    /**
-     * Clear the progress bar when complete.
-     * @default false
-     */
-    clear?: boolean | undefined;
-    /**
-     * Minimum time between renders in milliseconds.
-     * ~60fps = 16ms throttle.
-     * @default 16
-     */
-    renderThrottle?: number | undefined;
-    /**
-     * Stream to write progress bar output to.
-     * @default process.stderr
-     */
-    stream?: NodeJS.WriteStream | undefined;
-    /**
-     * Color to apply to the completed portion of the bar.
-     * @default 'cyan'
-     */
-    color?: 'cyan' | 'green' | 'yellow' | 'blue' | 'magenta' | undefined;
-}
-export declare class ProgressBar {
-    private current;
-    private total;
-    private startTime;
-    private lastRender;
-    private stream;
-    private options;
-    private terminated;
-    private lastDrawnWidth;
-    /**
-     * Create a new progress bar instance.
-     *
-     * @param total - Total number of units for the progress bar
-     * @param options - Configuration options for the progress bar
-     *
-     * @example
-     * ```ts
-     * const bar = new ProgressBar(100, {
-     *   width: 50,
-     *   format: ':bar :percent :current/:total :eta',
-     *   color: 'green'
-     * })
-     * ```
-     */
-    constructor(total: number, options?: ProgressBarOptions);
-    /**
-     * Update progress to a specific value and redraw the bar.
-     * Updates are throttled to prevent excessive rendering (default ~60fps).
-     *
-     * @param current - Current progress value (will be clamped to total)
-     * @param tokens - Optional custom tokens to replace in format string
-     *
-     * @example
-     * ```ts
-     * bar.update(50)
-     * bar.update(75, { status: 'Processing...' })
-     * ```
-     */
-    update(current: number, tokens?: Record<string, unknown>): void;
-    /**
-     * Increment progress by a specified amount.
-     * Convenience method for `update(current + amount)`.
-     *
-     * @param amount - Amount to increment by
-     * @param tokens - Optional custom tokens to replace in format string
-     * @default amount 1
-     *
-     * @example
-     * ```ts
-     * bar.tick() // Increment by 1
-     * bar.tick(5) // Increment by 5
-     * bar.tick(1, { file: 'data.json' })
-     * ```
-     */
-    tick(amount?: number, tokens?: Record<string, unknown>): void;
-    /**
-     * Render the progress bar.
-     */
-    private render;
-    /**
-     * Clear the current line.
-     */
-    private clearLine;
-    /**
-     * Format time in seconds to human readable.
-     */
-    private formatTime;
-    /**
-     * Terminate the progress bar and optionally clear it.
-     * Called automatically when progress reaches 100%.
-     * If `clear` option is true, removes the bar from terminal.
-     * Otherwise, moves to next line to preserve the final state.
-     */
-    terminate(): void;
-}
-/**
- * Create a simple progress indicator without a graphical bar.
- * Returns a formatted string showing progress as percentage and fraction.
- *
- * @param current - Current progress value
- * @param total - Total progress value
- * @param label - Optional label prefix
- * @returns Formatted progress indicator string
- *
- * @example
- * ```ts
- * createProgressIndicator(50, 100)
- * // Returns: '[50%] 50/100'
- *
- * createProgressIndicator(3, 10, 'Files')
- * // Returns: 'Files: [30%] 3/10'
- * ```
- */
-export declare function createProgressIndicator(current: number, total: number, label?: string | undefined): string;

package/dist/stdio/progress.js

@@ -1,212 +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 progress_exports = {};
-__export(progress_exports, {
-  ProgressBar: () => ProgressBar,
-  createProgressIndicator: () => createProgressIndicator
-});
-module.exports = __toCommonJS(progress_exports);
-var import_node_process = __toESM(require("node:process"));
-var import_yoctocolors_cjs = __toESM(require("../external/yoctocolors-cjs"));
-var import_strings = require("../strings");
-class ProgressBar {
-  current = 0;
-  total;
-  startTime;
-  lastRender = 0;
-  stream;
-  options;
-  terminated = false;
-  lastDrawnWidth = 0;
-  /**
-   * Create a new progress bar instance.
-   *
-   * @param total - Total number of units for the progress bar
-   * @param options - Configuration options for the progress bar
-   *
-   * @example
-   * ```ts
-   * const bar = new ProgressBar(100, {
-   *   width: 50,
-   *   format: ':bar :percent :current/:total :eta',
-   *   color: 'green'
-   * })
-   * ```
-   */
-  constructor(total, options) {
-    this.total = total;
-    this.startTime = Date.now();
-    this.stream = options?.stream || import_node_process.default.stderr;
-    this.options = {
-      width: 40,
-      format: ":bar :percent :current/:total",
-      complete: "\u2588",
-      incomplete: "\u2591",
-      head: "",
-      clear: false,
-      // ~60fps.
-      renderThrottle: 16,
-      stream: this.stream,
-      color: "cyan",
-      ...options
-    };
-  }
-  /**
-   * Update progress to a specific value and redraw the bar.
-   * Updates are throttled to prevent excessive rendering (default ~60fps).
-   *
-   * @param current - Current progress value (will be clamped to total)
-   * @param tokens - Optional custom tokens to replace in format string
-   *
-   * @example
-   * ```ts
-   * bar.update(50)
-   * bar.update(75, { status: 'Processing...' })
-   * ```
-   */
-  update(current, tokens) {
-    if (this.terminated) {
-      return;
-    }
-    this.current = Math.min(current, this.total);
-    const now = Date.now();
-    if (now - this.lastRender < this.options.renderThrottle && this.current < this.total) {
-      return;
-    }
-    this.lastRender = now;
-    this.render(tokens);
-    if (this.current >= this.total) {
-      this.terminate();
-    }
-  }
-  /**
-   * Increment progress by a specified amount.
-   * Convenience method for `update(current + amount)`.
-   *
-   * @param amount - Amount to increment by
-   * @param tokens - Optional custom tokens to replace in format string
-   * @default amount 1
-   *
-   * @example
-   * ```ts
-   * bar.tick() // Increment by 1
-   * bar.tick(5) // Increment by 5
-   * bar.tick(1, { file: 'data.json' })
-   * ```
-   */
-  tick(amount = 1, tokens) {
-    this.update(this.current + amount, tokens);
-  }
-  /**
-   * Render the progress bar.
-   */
-  render(tokens) {
-    const colorFn = import_yoctocolors_cjs.default[this.options.color] || ((s) => s);
-    const percent = this.total === 0 ? 0 : Math.floor(this.current / this.total * 100);
-    const elapsed = Date.now() - this.startTime;
-    const eta = this.current === 0 ? 0 : elapsed / this.current * (this.total - this.current);
-    const availableWidth = this.options.width;
-    const filledWidth = this.total === 0 ? 0 : Math.floor(this.current / this.total * availableWidth);
-    const emptyWidth = availableWidth - filledWidth;
-    const filled = (0, import_strings.repeatString)(this.options.complete, filledWidth);
-    const empty = (0, import_strings.repeatString)(this.options.incomplete, emptyWidth);
-    const bar = colorFn(filled) + empty;
-    let output = this.options.format;
-    output = output.replace(":bar", bar);
-    output = output.replace(":percent", `${percent}%`);
-    output = output.replace(":current", String(this.current));
-    output = output.replace(":total", String(this.total));
-    output = output.replace(":elapsed", this.formatTime(elapsed));
-    output = output.replace(":eta", this.formatTime(eta));
-    if (tokens) {
-      for (const [key, value] of Object.entries(tokens)) {
-        output = output.replace(`:${key}`, String(value));
-      }
-    }
-    this.clearLine();
-    this.stream.write(output);
-    this.lastDrawnWidth = (0, import_strings.stripAnsi)(output).length;
-  }
-  /**
-   * Clear the current line.
-   */
-  clearLine() {
-    if (this.stream.isTTY) {
-      this.stream.cursorTo(0);
-      this.stream.clearLine(0);
-    } else if (this.lastDrawnWidth > 0) {
-      this.stream.write(`\r${(0, import_strings.repeatString)(" ", this.lastDrawnWidth)}\r`);
-    }
-  }
-  /**
-   * Format time in seconds to human readable.
-   */
-  formatTime(ms) {
-    const seconds = Math.round(ms / 1e3);
-    if (seconds < 60) {
-      return `${seconds}s`;
-    }
-    const minutes = Math.floor(seconds / 60);
-    const remainingSeconds = seconds % 60;
-    return `${minutes}m${remainingSeconds}s`;
-  }
-  /**
-   * Terminate the progress bar and optionally clear it.
-   * Called automatically when progress reaches 100%.
-   * If `clear` option is true, removes the bar from terminal.
-   * Otherwise, moves to next line to preserve the final state.
-   */
-  terminate() {
-    if (this.terminated) {
-      return;
-    }
-    this.terminated = true;
-    if (this.options.clear) {
-      this.clearLine();
-    } else {
-      this.stream.write("\n");
-    }
-  }
-}
-function createProgressIndicator(current, total, label) {
-  const percent = total === 0 ? 0 : Math.floor(current / total * 100);
-  const progress = `${current}/${total}`;
-  let output = "";
-  if (label) {
-    output += `${label}: `;
-  }
-  output += `${import_yoctocolors_cjs.default.cyan(`[${percent}%]`)} ${progress}`;
-  return output;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ProgressBar,
-  createProgressIndicator
-});

package/dist/stdio/prompts.d.ts

@@ -1,195 +0,0 @@
-import checkboxRaw from '../external/@inquirer/checkbox';
-import confirmRaw from '../external/@inquirer/confirm';
-import inputRaw from '../external/@inquirer/input';
-import passwordRaw from '../external/@inquirer/password';
-import { type ThemeName } from '../themes/themes';
-import type { Theme } from '../themes/types';
-// Modules imported at the top - extract default and Separator
-declare const searchRaw: any;
-declare const selectRaw: any;
-declare const ActualSeparator: any;
-// Type definitions
-/**
- * Choice option for select and search prompts.
- *
- * @template Value - Type of the choice value
- */
-export interface Choice<Value = unknown> {
-    /** The value returned when this choice is selected */
-    value: Value;
-    /** Display name for the choice (defaults to value.toString()) */
-    name?: string | undefined;
-    /** Additional description text shown below the choice */
-    description?: string | undefined;
-    /** Short text shown after selection (defaults to name) */
-    short?: string | undefined;
-    /** Whether this choice is disabled, or a reason string */
-    disabled?: boolean | string | undefined;
-}
-/**
- * Context for inquirer prompts.
- * Minimal context interface used by Inquirer prompts.
- * Duplicated from `@inquirer/type` - InquirerContext.
- */
-interface InquirerContext {
-    /** Abort signal for cancelling the prompt */
-    signal?: AbortSignal | undefined;
-    /** Input stream (defaults to process.stdin) */
-    input?: NodeJS.ReadableStream | undefined;
-    /** Output stream (defaults to process.stdout) */
-    output?: NodeJS.WritableStream | undefined;
-    /** Clear the prompt from terminal when done */
-    clearPromptOnDone?: boolean | undefined;
-}
-/**
- * Extended context with spinner support.
- * Allows passing a spinner instance to be managed during prompts.
- */
-export type Context = import('../objects').Remap<InquirerContext & {
-    /** Optional spinner to stop/start during prompt display */
-    spinner?: import('../spinner').Spinner | undefined;
-}>;
-/**
- * Separator for visual grouping in select/checkbox prompts.
- * Creates a non-selectable visual separator line.
- * Duplicated from `@inquirer/select` - Separator.
- * This type definition ensures the Separator type is available in published packages.
- *
- * @example
- * import { Separator } from './prompts'
- *
- * const choices = [
- *   { name: 'Option 1', value: 1 },
- *   new Separator(),
- *   { name: 'Option 2', value: 2 }
- * ]
- */
-declare class SeparatorType {
-    readonly separator: string;
-    readonly type: 'separator';
-    constructor(separator?: string);
-}
-export type Separator = SeparatorType;
-/**
- * Convert Socket theme to @inquirer theme format.
- * Maps our theme colors to inquirer's style functions.
- * Handles theme names, Theme objects, and passes through @inquirer themes.
- *
- * @param theme - Socket theme name, Theme object, or @inquirer theme
- * @returns @inquirer theme object
- *
- * @example
- * ```ts
- * // Socket theme name
- * createInquirerTheme('sunset')
- *
- * // Socket Theme object
- * createInquirerTheme(SUNSET_THEME)
- *
- * // @inquirer theme (passes through)
- * createInquirerTheme({ style: {...}, icon: {...} })
- * ```
- */
-export declare function createInquirerTheme(theme: Theme | ThemeName | unknown): Record<string, unknown>;
-/**
- * Wrap an inquirer prompt with spinner handling, theme injection, and signal injection.
- * Automatically stops/starts spinners during prompt display, injects the current theme,
- * and injects abort signals. Trims string results and handles cancellation gracefully.
- *
- * @template T - Type of the prompt result
- * @param inquirerPrompt - The inquirer prompt function to wrap
- * @returns Wrapped prompt function with spinner, theme, and signal handling
- *
- * @example
- * const myPrompt = wrapPrompt(rawInquirerPrompt)
- * const result = await myPrompt({ message: 'Enter name:' })
- */
-/*@__NO_SIDE_EFFECTS__*/
-export declare function wrapPrompt<T = unknown>(inquirerPrompt: (...args: unknown[]) => Promise<T>): (...args: unknown[]) => Promise<T | undefined>;
-/**
- * Prompt to select multiple items from a list of choices.
- * Wrapped with spinner handling and abort signal support.
- *
- * @example
- * const choices = await checkbox({
- *   message: 'Select options:',
- *   choices: [
- *     { name: 'Option 1', value: 'opt1' },
- *     { name: 'Option 2', value: 'opt2' },
- *     { name: 'Option 3', value: 'opt3' }
- *   ]
- * })
- */
-export declare const checkbox: typeof checkboxRaw;
-/**
- * Prompt for a yes/no confirmation.
- * Wrapped with spinner handling and abort signal support.
- *
- * @example
- * const answer = await confirm({ message: 'Continue?' })
- * if (answer) { // user confirmed }
- */
-export declare const confirm: typeof confirmRaw;
-/**
- * Prompt for text input.
- * Wrapped with spinner handling and abort signal support.
- * Result is automatically trimmed.
- *
- * @example
- * const name = await input({ message: 'Enter your name:' })
- */
-export declare const input: typeof inputRaw;
-/**
- * Prompt for password input (hidden characters).
- * Wrapped with spinner handling and abort signal support.
- *
- * @example
- * const token = await password({ message: 'Enter API token:' })
- */
-export declare const password: typeof passwordRaw;
-/**
- * Prompt with searchable/filterable choices.
- * Wrapped with spinner handling and abort signal support.
- *
- * @example
- * const result = await search({
- *   message: 'Select a package:',
- *   source: async (input) => fetchPackages(input)
- * })
- */
-export declare const search: typeof searchRaw;
-/**
- * Prompt to select from a list of choices.
- * Wrapped with spinner handling and abort signal support.
- *
- * @example
- * const choice = await select({
- *   message: 'Choose an option:',
- *   choices: [
- *     { name: 'Option 1', value: 'opt1' },
- *     { name: 'Option 2', value: 'opt2' }
- *   ]
- * })
- */
-export declare const select: typeof selectRaw;
-export { ActualSeparator as Separator };
-/**
- * Create a separator for select prompts.
- * Creates a visual separator line in choice lists.
- *
- * @param text - Optional separator text (defaults to '───────')
- * @returns Separator instance
- *
- * @example
- * import { select, createSeparator } from '@socketsecurity/lib/stdio/prompts'
- *
- * const choice = await select({
- *   message: 'Choose an option:',
- *   choices: [
- *     { name: 'Option 1', value: 1 },
- *     createSeparator(),
- *     { name: 'Option 2', value: 2 }
- *   ]
- * })
- */
-export declare function createSeparator(text?: string): InstanceType<typeof ActualSeparator>;