You're Invited:Meet the Socket Team at RSAC and BSidesSF 2026, March 23–26.RSVP →
@inquirer/search
Advanced tools
@inquirer/search - npm Package Compare versions
+3
-4
| { | ||
| "name": "@inquirer/search", | ||
| "version": "4.1.4", | ||
| "version": "4.1.5", | ||
| "description": "Inquirer search prompt", | ||
@@ -70,3 +70,3 @@ "keywords": [ | ||
| "dependencies": { | ||
| "@inquirer/core": "^11.1.5", | ||
| "@inquirer/core": "^11.1.6", | ||
| "@inquirer/figures": "^2.0.3", | ||
@@ -76,3 +76,2 @@ "@inquirer/type": "^4.0.3" | ||
| "devDependencies": { | ||
| "@inquirer/testing": "^3.3.0", | ||
| "typescript": "^5.9.3" | ||
@@ -93,3 +92,3 @@ }, | ||
| "types": "./dist/index.d.ts", | ||
| "gitHead": "526eca2e64853510821ffd457561840ec0cbfb93" | ||
| "gitHead": "1ce03199b82b4a5fb6f7c97ce374c6da5087444f" | ||
| } |
| import { Separator, type Theme } from '@inquirer/core'; | ||
| import type { PartialDeep } from '@inquirer/type'; | ||
| type SearchTheme = { | ||
| icon: { | ||
| cursor: string; | ||
| }; | ||
| style: { | ||
| disabled: (text: string) => string; | ||
| searchTerm: (text: string) => string; | ||
| description: (text: string) => string; | ||
| keysHelpTip: (keys: [key: string, action: string][]) => string | undefined; | ||
| }; | ||
| }; | ||
| type Choice<Value> = { | ||
| value: Value; | ||
| name?: string; | ||
| description?: string; | ||
| short?: string; | ||
| disabled?: boolean | string; | ||
| type?: never; | ||
| }; | ||
| declare const _default: <Value>(config: { | ||
| message: string; | ||
| source: (term: string | undefined, opt: { | ||
| signal: AbortSignal; | ||
| }) => readonly (string | Separator)[] | readonly (Separator | Choice<Value>)[] | Promise<readonly (string | Separator)[]> | Promise<readonly (Separator | Choice<Value>)[]>; | ||
| validate?: ((value: Value) => boolean | string | Promise<string | boolean>) | undefined; | ||
| pageSize?: number | undefined; | ||
| default?: NoInfer<Value> | undefined; | ||
| theme?: PartialDeep<Theme<SearchTheme>> | undefined; | ||
| }, context?: import("@inquirer/type").Context) => Promise<Value>; | ||
| export default _default; | ||
| export { Separator } from '@inquirer/core'; |
-193
| import { createPrompt, useState, useKeypress, usePrefix, usePagination, useEffect, useMemo, useRef, isDownKey, isEnterKey, isTabKey, isUpKey, Separator, makeTheme, } from '@inquirer/core'; | ||
| import { styleText } from 'node:util'; | ||
| import figures from '@inquirer/figures'; | ||
| const searchTheme = { | ||
| icon: { cursor: figures.pointer }, | ||
| style: { | ||
| disabled: (text) => styleText('dim', `- ${text}`), | ||
| searchTerm: (text) => styleText('cyan', text), | ||
| description: (text) => styleText('cyan', text), | ||
| keysHelpTip: (keys) => keys | ||
| .map(([key, action]) => `${styleText('bold', key)} ${styleText('dim', action)}`) | ||
| .join(styleText('dim', ' • ')), | ||
| }, | ||
| }; | ||
| function isSelectable(item) { | ||
| return !Separator.isSeparator(item) && !item.disabled; | ||
| } | ||
| function normalizeChoices(choices) { | ||
| return choices.map((choice) => { | ||
| if (Separator.isSeparator(choice)) | ||
| return choice; | ||
| if (typeof choice === 'string') { | ||
| return { | ||
| value: choice, | ||
| name: choice, | ||
| short: choice, | ||
| disabled: false, | ||
| }; | ||
| } | ||
| const name = choice.name ?? String(choice.value); | ||
| const normalizedChoice = { | ||
| value: choice.value, | ||
| name, | ||
| short: choice.short ?? name, | ||
| disabled: choice.disabled ?? false, | ||
| }; | ||
| if (choice.description) { | ||
| normalizedChoice.description = choice.description; | ||
| } | ||
| return normalizedChoice; | ||
| }); | ||
| } | ||
| export default createPrompt((config, done) => { | ||
| const { pageSize = 7, validate = () => true } = config; | ||
| const theme = makeTheme(searchTheme, config.theme); | ||
| const [status, setStatus] = useState('loading'); | ||
| const [searchTerm, setSearchTerm] = useState(''); | ||
| const [searchResults, setSearchResults] = useState([]); | ||
| const [searchError, setSearchError] = useState(); | ||
| const defaultApplied = useRef(false); | ||
| const prefix = usePrefix({ status, theme }); | ||
| const bounds = useMemo(() => { | ||
| const first = searchResults.findIndex(isSelectable); | ||
| const last = searchResults.findLastIndex(isSelectable); | ||
| return { first, last }; | ||
| }, [searchResults]); | ||
| const [active = bounds.first, setActive] = useState(); | ||
| useEffect(() => { | ||
| const controller = new AbortController(); | ||
| setStatus('loading'); | ||
| setSearchError(undefined); | ||
| const fetchResults = async () => { | ||
| try { | ||
| const results = await config.source(searchTerm || undefined, { | ||
| signal: controller.signal, | ||
| }); | ||
| if (!controller.signal.aborted) { | ||
| const normalized = normalizeChoices(results); | ||
| let initialActive; | ||
| if (!defaultApplied.current && 'default' in config) { | ||
| const defaultIndex = normalized.findIndex((item) => isSelectable(item) && item.value === config.default); | ||
| initialActive = defaultIndex === -1 ? undefined : defaultIndex; | ||
| defaultApplied.current = true; | ||
| } | ||
| setActive(initialActive); | ||
| setSearchError(undefined); | ||
| setSearchResults(normalized); | ||
| setStatus('idle'); | ||
| } | ||
| } | ||
| catch (error) { | ||
| if (!controller.signal.aborted && error instanceof Error) { | ||
| setSearchError(error.message); | ||
| } | ||
| } | ||
| }; | ||
| void fetchResults(); | ||
| return () => { | ||
| controller.abort(); | ||
| }; | ||
| }, [searchTerm]); | ||
| // Safe to assume the cursor position never points to a Separator. | ||
| const selectedChoice = searchResults[active]; | ||
| useKeypress(async (key, rl) => { | ||
| if (isEnterKey(key)) { | ||
| if (selectedChoice) { | ||
| setStatus('loading'); | ||
| const isValid = await validate(selectedChoice.value); | ||
| setStatus('idle'); | ||
| if (isValid === true) { | ||
| setStatus('done'); | ||
| done(selectedChoice.value); | ||
| } | ||
| else if (selectedChoice.name === searchTerm) { | ||
| setSearchError(isValid || 'You must provide a valid value'); | ||
| } | ||
| else { | ||
| // Reset line with new search term | ||
| rl.write(selectedChoice.name); | ||
| setSearchTerm(selectedChoice.name); | ||
| } | ||
| } | ||
| else { | ||
| // Reset the readline line value to the previous value. On line event, the value | ||
| // get cleared, forcing the user to re-enter the value instead of fixing it. | ||
| rl.write(searchTerm); | ||
| } | ||
| } | ||
| else if (isTabKey(key) && selectedChoice) { | ||
| rl.clearLine(0); // Remove the tab character. | ||
| rl.write(selectedChoice.name); | ||
| setSearchTerm(selectedChoice.name); | ||
| } | ||
| else if (status !== 'loading' && (isUpKey(key) || isDownKey(key))) { | ||
| rl.clearLine(0); | ||
| if ((isUpKey(key) && active !== bounds.first) || | ||
| (isDownKey(key) && active !== bounds.last)) { | ||
| const offset = isUpKey(key) ? -1 : 1; | ||
| let next = active; | ||
| do { | ||
| next = (next + offset + searchResults.length) % searchResults.length; | ||
| } while (!isSelectable(searchResults[next])); | ||
| setActive(next); | ||
| } | ||
| } | ||
| else { | ||
| setSearchTerm(rl.line); | ||
| } | ||
| }); | ||
| const message = theme.style.message(config.message, status); | ||
| const helpLine = theme.style.keysHelpTip([ | ||
| ['↑↓', 'navigate'], | ||
| ['⏎', 'select'], | ||
| ]); | ||
| const page = usePagination({ | ||
| items: searchResults, | ||
| active, | ||
| renderItem({ item, isActive }) { | ||
| if (Separator.isSeparator(item)) { | ||
| return ` ${item.separator}`; | ||
| } | ||
| if (item.disabled) { | ||
| const disabledLabel = typeof item.disabled === 'string' ? item.disabled : '(disabled)'; | ||
| return theme.style.disabled(`${item.name} ${disabledLabel}`); | ||
| } | ||
| const color = isActive ? theme.style.highlight : (x) => x; | ||
| const cursor = isActive ? theme.icon.cursor : ` `; | ||
| return color(`${cursor} ${item.name}`); | ||
| }, | ||
| pageSize, | ||
| loop: false, | ||
| }); | ||
| let error; | ||
| if (searchError) { | ||
| error = theme.style.error(searchError); | ||
| } | ||
| else if (searchResults.length === 0 && searchTerm !== '' && status === 'idle') { | ||
| error = theme.style.error('No results found'); | ||
| } | ||
| let searchStr; | ||
| if (status === 'done' && selectedChoice) { | ||
| return [prefix, message, theme.style.answer(selectedChoice.short)] | ||
| .filter(Boolean) | ||
| .join(' ') | ||
| .trimEnd(); | ||
| } | ||
| else { | ||
| searchStr = theme.style.searchTerm(searchTerm); | ||
| } | ||
| const description = selectedChoice?.description; | ||
| const header = [prefix, message, searchStr].filter(Boolean).join(' ').trimEnd(); | ||
| const body = [ | ||
| error ?? page, | ||
| ' ', | ||
| description ? theme.style.description(description) : '', | ||
| helpLine, | ||
| ] | ||
| .filter(Boolean) | ||
| .join('\n') | ||
| .trimEnd(); | ||
| return [header, body]; | ||
| }); | ||
| export { Separator } from '@inquirer/core'; |
New alerts
Empty package
Supply chain riskPackage does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Dev dependency count
1
-50%Worsened metrics
- Total package byte prevSize
10354
-45.94%- Number of package files
3
-40%- Lines of code
0
-100%- Number of medium supply chain risk alerts
2
Infinity%Dependency changes
Updated
@inquirer/core@^11.1.6