@socketsecurity/lib 5.19.0 → 5.19.1

package/dist/stdio/prompts.d.ts

@@ -0,0 +1,196 @@
+/**
+ * @fileoverview User prompt utilities for interactive scripts.
+ * Provides inquirer.js integration with spinner support, context handling, and theming.
+ */
+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';
+declare const searchRaw: any;
+declare const selectRaw: any;
+declare const ActualSeparator: any;
+/**
+ * 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>;
+/**
+ * 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>;
+/**
+ * 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:' })
+ */
+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 };

package/dist/stdio/prompts.js

@@ -0,0 +1,177 @@
+"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 prompts_exports = {};
+__export(prompts_exports, {
+  Separator: () => ActualSeparator,
+  checkbox: () => checkbox,
+  confirm: () => confirm,
+  createInquirerTheme: () => createInquirerTheme,
+  createSeparator: () => createSeparator,
+  input: () => input,
+  password: () => password,
+  search: () => search,
+  select: () => select,
+  wrapPrompt: () => wrapPrompt
+});
+module.exports = __toCommonJS(prompts_exports);
+var import_process = require("../constants/process");
+var import_checkbox = __toESM(require("../external/@inquirer/checkbox"));
+var import_confirm = __toESM(require("../external/@inquirer/confirm"));
+var import_input = __toESM(require("../external/@inquirer/input"));
+var import_password = __toESM(require("../external/@inquirer/password"));
+var searchModule = __toESM(require("../external/@inquirer/search"));
+var selectModuleImport = __toESM(require("../external/@inquirer/select"));
+var import_yoctocolors_cjs = __toESM(require("../external/yoctocolors-cjs"));
+var import_spinner = require("../spinner");
+var import_context = require("../themes/context");
+var import_themes = require("../themes/themes");
+var import_utils = require("../themes/utils");
+const abortSignal = (0, import_process.getAbortSignal)();
+const spinner = (0, import_spinner.getDefaultSpinner)();
+const searchRaw = searchModule.default;
+const selectModule = selectModuleImport;
+const selectRaw = selectModule.default;
+const ActualSeparator = selectModule.Separator;
+function applyColor(text, color) {
+  if (typeof color === "string") {
+    return import_yoctocolors_cjs.default[color](text);
+  }
+  const { 0: r, 1: g, 2: b } = color;
+  return `\x1B[38;2;${r};${g};${b}m${text}\x1B[39m`;
+}
+function isSocketTheme(value) {
+  return typeof value === "object" && value !== null && "name" in value && "colors" in value;
+}
+function resolveTheme(theme) {
+  return typeof theme === "string" ? import_themes.THEMES[theme] ?? import_themes.THEMES.socket : theme;
+}
+function createInquirerTheme(theme) {
+  if (typeof theme === "string" || isSocketTheme(theme)) {
+    const socketTheme = resolveTheme(theme);
+    const promptColor = (0, import_utils.resolveColor)(
+      socketTheme.colors.prompt,
+      socketTheme.colors
+    );
+    const textDimColor = (0, import_utils.resolveColor)(
+      socketTheme.colors.textDim,
+      socketTheme.colors
+    );
+    const errorColor = socketTheme.colors.error;
+    const successColor = socketTheme.colors.success;
+    const primaryColor = socketTheme.colors.primary;
+    return {
+      style: {
+        // Message text (uses colors.prompt)
+        message: (text) => applyColor(text, promptColor),
+        // Answer text (uses primary color)
+        answer: (text) => applyColor(text, primaryColor),
+        // Help text / descriptions (uses textDim)
+        help: (text) => applyColor(text, textDimColor),
+        description: (text) => applyColor(text, textDimColor),
+        // Disabled items (uses textDim)
+        disabled: (text) => applyColor(text, textDimColor),
+        // Error messages (uses error color)
+        error: (text) => applyColor(text, errorColor),
+        // Highlight/active (uses primary color)
+        highlight: (text) => applyColor(text, primaryColor)
+      },
+      icon: {
+        // Use success color for confirmed items
+        checked: applyColor("\u2713", successColor),
+        unchecked: " ",
+        // Cursor uses primary color
+        cursor: applyColor("\u276F", primaryColor)
+      }
+    };
+  }
+  return theme;
+}
+function createSeparator(text) {
+  return new ActualSeparator(text);
+}
+// @__NO_SIDE_EFFECTS__
+function wrapPrompt(inquirerPrompt) {
+  return async (...args) => {
+    const origContext = args.length > 1 ? args[1] : void 0;
+    const { spinner: contextSpinner, ...contextWithoutSpinner } = origContext ?? {};
+    const spinnerInstance = contextSpinner !== void 0 ? contextSpinner : spinner;
+    const signal = abortSignal;
+    const config = args[0];
+    if (config && typeof config === "object") {
+      if (!config["theme"]) {
+        config["theme"] = createInquirerTheme((0, import_context.getTheme)());
+      } else {
+        config["theme"] = createInquirerTheme(config["theme"]);
+      }
+    }
+    if (origContext) {
+      args[1] = {
+        signal,
+        ...contextWithoutSpinner
+      };
+    } else {
+      args[1] = { signal };
+    }
+    const wasSpinning = !!spinnerInstance?.isSpinning;
+    spinnerInstance?.stop();
+    let result;
+    try {
+      result = await inquirerPrompt(...args);
+    } catch (e) {
+      if (e instanceof TypeError) {
+        throw e;
+      }
+    }
+    if (wasSpinning) {
+      spinnerInstance.start();
+    }
+    return typeof result === "string" ? result.trim() : result;
+  };
+}
+const checkbox = /* @__PURE__ */ wrapPrompt(import_checkbox.default);
+const confirm = /* @__PURE__ */ wrapPrompt(import_confirm.default);
+const input = /* @__PURE__ */ wrapPrompt(import_input.default);
+const password = /* @__PURE__ */ wrapPrompt(import_password.default);
+const search = /* @__PURE__ */ wrapPrompt(searchRaw);
+const select = /* @__PURE__ */ wrapPrompt(selectRaw);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Separator,
+  checkbox,
+  confirm,
+  createInquirerTheme,
+  createSeparator,
+  input,
+  password,
+  search,
+  select,
+  wrapPrompt
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@socketsecurity/lib",
-  "version": "5.19.0",
+  "version": "5.19.1",
   "packageManager": "pnpm@11.0.0-rc.2",
   "license": "MIT",
   "description": "Core utilities and infrastructure for Socket.dev security tools",
@@ -575,6 +575,10 @@
       "types": "./dist/ssri.d.ts",
       "default": "./dist/ssri.js"
     },
+    "./stdio/clear": {
+      "types": "./dist/stdio/clear.d.ts",
+      "default": "./dist/stdio/clear.js"
+    },
     "./stdio/divider": {
       "types": "./dist/stdio/divider.d.ts",
       "default": "./dist/stdio/divider.js"
@@ -587,6 +591,14 @@
       "types": "./dist/stdio/header.d.ts",
       "default": "./dist/stdio/header.js"
     },
+    "./stdio/progress": {
+      "types": "./dist/stdio/progress.d.ts",
+      "default": "./dist/stdio/progress.js"
+    },
+    "./stdio/prompts": {
+      "types": "./dist/stdio/prompts.d.ts",
+      "default": "./dist/stdio/prompts.js"
+    },
     "./stdio/stderr": {
       "types": "./dist/stdio/stderr.d.ts",
       "default": "./dist/stdio/stderr.js"
@@ -699,13 +711,19 @@
     "@babel/parser": "7.28.4",
     "@babel/traverse": "7.28.4",
     "@babel/types": "7.28.4",
+    "@inquirer/checkbox": "5.1.3",
+    "@inquirer/confirm": "6.0.11",
+    "@inquirer/input": "5.0.11",
+    "@inquirer/password": "5.0.11",
+    "@inquirer/search": "4.1.7",
+    "@inquirer/select": "5.1.3",
     "@npmcli/arborist": "9.1.4",
     "@npmcli/package-json": "7.0.0",
     "@npmcli/promise-spawn": "8.0.3",
     "@socketregistry/is-unicode-supported": "1.0.5",
     "@socketregistry/packageurl-js": "1.4.2",
     "@socketregistry/yocto-spinner": "1.0.25",
-    "@socketsecurity/lib-stable": "npm:@socketsecurity/lib@5.18.2",
+    "@socketsecurity/lib-stable": "npm:@socketsecurity/lib@5.19.0",
     "@types/node": "24.9.2",
     "@typescript/native-preview": "7.0.0-dev.20260415.1",
     "@vitest/coverage-v8": "4.0.3",