@socketsecurity/lib 5.28.0 → 6.0.1

package/dist/stdio/prompts.d.ts

@@ -1,11 +1,12 @@
 /**
- * @fileoverview User prompt utilities for interactive scripts.
- * Provides inquirer.js integration with spinner support, context handling, and theming.
+ * @file 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 { ColorValue } from '../colors/types';
 import { type ThemeName } from '../themes/themes';
 import type { Theme } from '../themes/types';
 declare const searchRaw: any;
@@ -14,57 +15,76 @@ declare const ActualSeparator: any;
 /**
  * Choice option for select and search prompts.
  *
- * @template Value - Type of the choice value
+ * @template Value - Type of the choice value.
  */
 export interface Choice<Value = unknown> {
-    /** The value returned when this choice is selected */
+    /**
+     * The value returned when this choice is selected.
+     */
     value: Value;
-    /** Display name for the choice (defaults to value.toString()) */
+    /**
+     * Display name for the choice (defaults to value.toString())
+     */
     name?: string | undefined;
-    /** Additional description text shown below the choice */
+    /**
+     * Additional description text shown below the choice.
+     */
     description?: string | undefined;
-    /** Short text shown after selection (defaults to name) */
+    /**
+     * Short text shown after selection (defaults to name)
+     */
     short?: string | undefined;
-    /** Whether this choice is disabled, or a reason string */
+    /**
+     * 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.
+ * Context for inquirer prompts. Minimal context interface used by Inquirer
+ * prompts. Duplicated from `@inquirer/type` - InquirerContext.
  */
 interface InquirerContext {
-    /** Abort signal for cancelling the prompt */
+    /**
+     * Abort signal for cancelling the prompt.
+     */
     signal?: AbortSignal | undefined;
-    /** Input stream (defaults to process.stdin) */
+    /**
+     * Input stream (defaults to process.stdin)
+     */
     input?: NodeJS.ReadableStream | undefined;
-    /** Output stream (defaults to process.stdout) */
+    /**
+     * Output stream (defaults to process.stdout)
+     */
     output?: NodeJS.WritableStream | undefined;
-    /** Clear the prompt from terminal when done */
+    /**
+     * 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.
+ * 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;
+export type Context = import('../objects/types').Remap<InquirerContext & {
+    /**
+     * Optional spinner to stop/start during prompt display.
+     */
+    spinner?: import('../spinner/types').SpinnerInstance | 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.
+ * 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'
+ *   import { Separator } from './prompts'
  *
- * const choices = [
- *   { name: 'Option 1', value: 1 },
- *   new Separator(),
- *   { name: 'Option 2', value: 2 }
- * ]
+ *   const choices = [
+ *     { name: 'Option 1', value: 1 },
+ *     new Separator(),
+ *     { name: 'Option 2', value: 2 },
+ *   ]
  */
 declare class SeparatorType {
     readonly separator: string;
@@ -73,124 +93,151 @@ declare class SeparatorType {
 }
 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.
+ * Apply a color to text using yoctocolors. Handles both named colors and RGB
+ * tuples.
  *
- * @param theme - Socket theme name, Theme object, or @inquirer theme
- * @returns @inquirer theme object
+ * @private
+ */
+export declare function applyColor(text: string, color: ColorValue): string;
+/**
+ * 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.
  *
  * @example
- * ```ts
- * // Socket theme name
- * createInquirerTheme('sunset')
+ *   ;```ts
+ *   // Socket theme name
+ *   createInquirerTheme('sunset')
+ *
+ *   // Socket Theme object
+ *   createInquirerTheme(SUNSET_THEME)
  *
- * // Socket Theme object
- * createInquirerTheme(SUNSET_THEME)
+ *   // @inquirer theme (passes through)
+ *   createInquirerTheme({ style: {...}, icon: {...} })
+ *   ```
  *
- * // @inquirer theme (passes through)
- * createInquirerTheme({ style: {...}, icon: {...} })
- * ```
+ * @param theme - Socket theme name, Theme object, or @inquirer theme.
+ *
+ * @returns @inquirer theme object
  */
 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.
+ * Create a separator for select prompts. Creates a visual separator line in
+ * choice lists.
+ *
+ * @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 },
+ *     ],
+ *   })
  *
  * @param text - Optional separator text (defaults to '───────')
+ *
  * @returns Separator instance
+ */
+export declare function createSeparator(text?: string): InstanceType<typeof ActualSeparator>;
+/**
+ * Check if value is a Socket Theme object.
  *
- * @example
- * import { select, createSeparator } from '@socketsecurity/lib/stdio/prompts'
+ * @param value - Value to check.
  *
- * const choice = await select({
- *   message: 'Choose an option:',
- *   choices: [
- *     { name: 'Option 1', value: 1 },
- *     createSeparator(),
- *     { name: 'Option 2', value: 2 }
- *   ]
- * })
+ * @returns True if value is a Socket Theme
  */
-export declare function createSeparator(text?: string): InstanceType<typeof ActualSeparator>;
+export declare function isSocketTheme(value: unknown): value is Theme;
 /**
- * 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.
+ * Resolve theme name or object to Theme.
  *
- * @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
+ * @param theme - Theme name or object.
+ *
+ * @returns Resolved Theme
+ */
+export declare function resolveTheme(theme: Theme | ThemeName): Theme;
+/**
+ * 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.
  *
  * @example
- * const myPrompt = wrapPrompt(rawInquirerPrompt)
- * const result = await myPrompt({ message: 'Enter name:' })
+ *   const myPrompt = wrapPrompt(rawInquirerPrompt)
+ *   const result = await myPrompt({ message: 'Enter name:' })
+ *
+ * @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
  */
 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.
+ * 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' }
- *   ]
- * })
+ *   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.
+ * 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 }
+ *   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.
+ * 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:' })
+ *   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.
+ * Prompt for password input (hidden characters). Wrapped with spinner handling
+ * and abort signal support.
  *
  * @example
- * const token = await password({ message: 'Enter API token:' })
+ *   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.
+ * 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)
- * })
+ *   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.
+ * 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' }
- *   ]
- * })
+ *   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

@@ -31,18 +31,21 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var prompts_exports = {};
 __export(prompts_exports, {
   Separator: () => ActualSeparator,
+  applyColor: () => applyColor,
   checkbox: () => checkbox,
   confirm: () => confirm,
   createInquirerTheme: () => createInquirerTheme,
   createSeparator: () => createSeparator,
   input: () => input,
+  isSocketTheme: () => isSocketTheme,
   password: () => password,
+  resolveTheme: () => resolveTheme,
   search: () => search,
   select: () => select,
   wrapPrompt: () => wrapPrompt
 });
 module.exports = __toCommonJS(prompts_exports);
-var import_process = require("../constants/process");
+var import_abort = require("../process/abort");
 var import_checkbox = __toESM(require("../external/@inquirer/checkbox"));
 var import_confirm = __toESM(require("../external/@inquirer/confirm"));
 var import_input = __toESM(require("../external/@inquirer/input"));
@@ -50,12 +53,12 @@ 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_default = require("../spinner/default");
 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)();
+var import_resolve = require("../themes/resolve");
+const abortSignal = (0, import_abort.getAbortSignal)();
+const spinner = (0, import_default.getDefaultSpinner)();
 const searchRaw = searchModule.default;
 const selectModule = selectModuleImport;
 const selectRaw = selectModule.default;
@@ -67,20 +70,14 @@ function applyColor(text, color) {
   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)(
+    const promptColor = (0, import_resolve.resolveColor)(
       socketTheme.colors.prompt,
       socketTheme.colors
     );
-    const textDimColor = (0, import_utils.resolveColor)(
+    const textDimColor = (0, import_resolve.resolveColor)(
       socketTheme.colors.textDim,
       socketTheme.colors
     );
@@ -104,19 +101,27 @@ function createInquirerTheme(theme) {
         highlight: (text) => applyColor(text, primaryColor)
       },
       icon: {
-        // Use success color for confirmed items
+        // oxlint-disable-next-line socket/no-status-emoji -- Inquirer theme icon; consumed by the prompt library, not log output.
         checked: applyColor("\u2713", successColor),
         unchecked: " ",
-        // Cursor uses primary color
         cursor: applyColor("\u276F", primaryColor)
       }
     };
   }
+  if (theme === void 0 || theme === null) {
+    return {};
+  }
   return theme;
 }
 function createSeparator(text) {
   return new ActualSeparator(text);
 }
+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;
+}
 // @__NO_SIDE_EFFECTS__
 function wrapPrompt(inquirerPrompt) {
   return async (...args) => {
@@ -165,12 +170,15 @@ const select = /* @__PURE__ */ wrapPrompt(selectRaw);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Separator,
+  applyColor,
   checkbox,
   confirm,
   createInquirerTheme,
   createSeparator,
   input,
+  isSocketTheme,
   password,
+  resolveTheme,
   search,
   select,
   wrapPrompt