@optique/inquirer 1.4.0-dev.2728 → 1.4.0-dev.2731

package/README.md

@@ -60,8 +60,7 @@ Features
 --------
 
  -  *Ten prompt types*: `input`, `password`, `number`, `confirm`, `select`,
-    `rawlist`, `expand`, `checkbox`, `editor`, and a custom `prompter` for
-    testing
+    `search`, `rawlist`, `expand`, `checkbox`, and `editor`
  -  *Transparent composition* with `bindEnv()` and `bindConfig()` — the
     prompt fires only when no higher-priority source supplies a value
  -  *Dependency-derived configurations* with `derivePromptConfig()` — later

package/dist/index.cjs

@@ -35,6 +35,7 @@ const defaultPromptFunctions = {
 	password: __inquirer_prompts.password,
 	editor: __inquirer_prompts.editor,
 	select: __inquirer_prompts.select,
+	search: __inquirer_prompts.search,
 	rawlist: __inquirer_prompts.rawlist,
 	expand: __inquirer_prompts.expand,
 	checkbox: __inquirer_prompts.checkbox
@@ -77,6 +78,7 @@ const validPromptTypes = new Set([
 	"password",
 	"editor",
 	"select",
+	"search",
 	"rawlist",
 	"expand",
 	"checkbox"
@@ -188,6 +190,16 @@ async function executePromptRaw(config, context) {
 					...cfg.default !== void 0 ? { default: cfg.default } : {}
 				}, inquirerContext)
 			};
+			case "search": return {
+				success: true,
+				value: await prompts.search({
+					message: cfg.message,
+					source: async (term, sourceContext) => normalizeChoices(await cfg.source(term, sourceContext)),
+					...cfg.default === void 0 ? {} : { default: cfg.default },
+					...cfg.pageSize === void 0 ? {} : { pageSize: cfg.pageSize },
+					...cfg.validate === void 0 ? {} : { validate: cfg.validate }
+				}, inquirerContext)
+			};
 			case "rawlist": return {
 				success: true,
 				value: await prompts.rawlist({

package/dist/index.d.cts

@@ -7,7 +7,7 @@ import { DerivePromptConfigContext, DerivePromptConfigNoDepsContext, DerivePromp
 
 /**
  * A choice item for selection-type prompts (`select`, `rawlist`, `expand`,
- * `checkbox`).
+ * `checkbox`, `search`).
  *
  * @since 1.0.0
  */
@@ -180,6 +180,32 @@ interface SelectConfig {
    */
   readonly prompter?: (context: PromptExecutionContext$1) => Promise<string>;
 }
+/**
+ * Configuration for a `search` prompt that loads choices for each search term.
+ *
+ * @since 1.4.0
+ */
+interface SearchConfig {
+  readonly type: "search";
+  /** The question to display to the user. */
+  readonly message: string;
+  /**
+   * Returns choices for the current input; undefined means empty input.
+   * Forward the signal to cancel requests when the input changes or the
+   * prompt closes. Inquirer displays Error rejections without ending the prompt.
+   */
+  readonly source: (term: string | undefined, context: {
+    readonly signal: AbortSignal;
+  }) => readonly (string | Choice | Separator)[] | Promise<readonly (string | Choice | Separator)[]>;
+  /** Initially highlighted choice value. */
+  readonly default?: string;
+  /** Number of choices displayed before pagination. */
+  readonly pageSize?: number;
+  /** Native validation called when the user submits a selection. */
+  readonly validate?: (value: string) => boolean | string | Promise<boolean | string>;
+  /** Overrides prompt execution. Useful for testing. */
+  readonly prompter?: (context: PromptExecutionContext$1) => Promise<string>;
+}
 /**
  * Configuration for a `rawlist` prompt (numbered list).
  *
@@ -240,7 +266,7 @@ interface CheckboxConfig {
  *
  * @since 1.0.0
  */
-type StringPromptConfig = InputConfig | PasswordConfig | EditorConfig | SelectConfig | RawlistConfig | ExpandConfig;
+type StringPromptConfig = InputConfig | PasswordConfig | EditorConfig | SelectConfig | SearchConfig | RawlistConfig | ExpandConfig;
 /**
  * Type-safe prompt configuration for a given parser value type `T`.
  *
@@ -284,4 +310,4 @@ type RuntimePromptConfig = ConfirmConfig | NumberPromptConfig | StringPromptConf
  */
 declare function prompt<M extends Mode, TValue, TState>(parser: Parser<M, TValue, TState>, config: PromptConfig<TValue> | DerivedPromptConfig$1<RuntimePromptConfig, NoInfer<TValue>>, options?: PromptOptions$1<NoInfer<TValue>>): FluentParser<"async", TValue, TState>;
 //#endregion
-export { CheckboxChoice, CheckboxConfig, Choice, ConfirmConfig, type DerivePromptConfigContext, type DerivePromptConfigNoDepsContext, type DerivePromptConfigNoDepsOptions, type DerivePromptConfigOptions, type DerivePromptConfigsContext, type DerivePromptConfigsOptions, type DerivedPromptConfig, EditorConfig, ExpandChoice, ExpandConfig, InputConfig, NumberPromptConfig, PasswordConfig, PromptConfig, type PromptExecutionContext, type PromptOptions, type PromptValidator, RawlistConfig, RuntimePromptConfig, SelectConfig, Separator, StringPromptConfig, derivePromptConfig, isDerivedPromptConfig, prompt };
+export { CheckboxChoice, CheckboxConfig, Choice, ConfirmConfig, type DerivePromptConfigContext, type DerivePromptConfigNoDepsContext, type DerivePromptConfigNoDepsOptions, type DerivePromptConfigOptions, type DerivePromptConfigsContext, type DerivePromptConfigsOptions, type DerivedPromptConfig, EditorConfig, ExpandChoice, ExpandConfig, InputConfig, NumberPromptConfig, PasswordConfig, PromptConfig, type PromptExecutionContext, type PromptOptions, type PromptValidator, RawlistConfig, RuntimePromptConfig, SearchConfig, SelectConfig, Separator, StringPromptConfig, derivePromptConfig, isDerivedPromptConfig, prompt };

package/dist/index.d.ts

@@ -7,7 +7,7 @@ import { Mode, Parser } from "@optique/core/parser";
 
 /**
  * A choice item for selection-type prompts (`select`, `rawlist`, `expand`,
- * `checkbox`).
+ * `checkbox`, `search`).
  *
  * @since 1.0.0
  */
@@ -180,6 +180,32 @@ interface SelectConfig {
    */
   readonly prompter?: (context: PromptExecutionContext$1) => Promise<string>;
 }
+/**
+ * Configuration for a `search` prompt that loads choices for each search term.
+ *
+ * @since 1.4.0
+ */
+interface SearchConfig {
+  readonly type: "search";
+  /** The question to display to the user. */
+  readonly message: string;
+  /**
+   * Returns choices for the current input; undefined means empty input.
+   * Forward the signal to cancel requests when the input changes or the
+   * prompt closes. Inquirer displays Error rejections without ending the prompt.
+   */
+  readonly source: (term: string | undefined, context: {
+    readonly signal: AbortSignal;
+  }) => readonly (string | Choice | Separator)[] | Promise<readonly (string | Choice | Separator)[]>;
+  /** Initially highlighted choice value. */
+  readonly default?: string;
+  /** Number of choices displayed before pagination. */
+  readonly pageSize?: number;
+  /** Native validation called when the user submits a selection. */
+  readonly validate?: (value: string) => boolean | string | Promise<boolean | string>;
+  /** Overrides prompt execution. Useful for testing. */
+  readonly prompter?: (context: PromptExecutionContext$1) => Promise<string>;
+}
 /**
  * Configuration for a `rawlist` prompt (numbered list).
  *
@@ -240,7 +266,7 @@ interface CheckboxConfig {
  *
  * @since 1.0.0
  */
-type StringPromptConfig = InputConfig | PasswordConfig | EditorConfig | SelectConfig | RawlistConfig | ExpandConfig;
+type StringPromptConfig = InputConfig | PasswordConfig | EditorConfig | SelectConfig | SearchConfig | RawlistConfig | ExpandConfig;
 /**
  * Type-safe prompt configuration for a given parser value type `T`.
  *
@@ -284,4 +310,4 @@ type RuntimePromptConfig = ConfirmConfig | NumberPromptConfig | StringPromptConf
  */
 declare function prompt<M extends Mode, TValue, TState>(parser: Parser<M, TValue, TState>, config: PromptConfig<TValue> | DerivedPromptConfig$1<RuntimePromptConfig, NoInfer<TValue>>, options?: PromptOptions$1<NoInfer<TValue>>): FluentParser<"async", TValue, TState>;
 //#endregion
-export { CheckboxChoice, CheckboxConfig, Choice, ConfirmConfig, type DerivePromptConfigContext, type DerivePromptConfigNoDepsContext, type DerivePromptConfigNoDepsOptions, type DerivePromptConfigOptions, type DerivePromptConfigsContext, type DerivePromptConfigsOptions, type DerivedPromptConfig, EditorConfig, ExpandChoice, ExpandConfig, InputConfig, NumberPromptConfig, PasswordConfig, PromptConfig, type PromptExecutionContext, type PromptOptions, type PromptValidator, RawlistConfig, RuntimePromptConfig, SelectConfig, Separator, StringPromptConfig, derivePromptConfig, isDerivedPromptConfig, prompt };
+export { CheckboxChoice, CheckboxConfig, Choice, ConfirmConfig, type DerivePromptConfigContext, type DerivePromptConfigNoDepsContext, type DerivePromptConfigNoDepsOptions, type DerivePromptConfigOptions, type DerivePromptConfigsContext, type DerivePromptConfigsOptions, type DerivedPromptConfig, EditorConfig, ExpandChoice, ExpandConfig, InputConfig, NumberPromptConfig, PasswordConfig, PromptConfig, type PromptExecutionContext, type PromptOptions, type PromptValidator, RawlistConfig, RuntimePromptConfig, SearchConfig, SelectConfig, Separator, StringPromptConfig, derivePromptConfig, isDerivedPromptConfig, prompt };

package/dist/index.js

@@ -1,5 +1,5 @@
 import process from "node:process";
-import { Separator, checkbox, confirm, editor, expand, input, number, password, rawlist, select } from "@inquirer/prompts";
+import { Separator, checkbox, confirm, editor, expand, input, number, password, rawlist, search, select } from "@inquirer/prompts";
 import { formatMessage, message } from "@optique/core/message";
 import { createPromptAdapter, derivePromptConfig, isDerivedPromptConfig } from "@optique/prompt";
 
@@ -12,6 +12,7 @@ const defaultPromptFunctions = {
 	password,
 	editor,
 	select,
+	search,
 	rawlist,
 	expand,
 	checkbox
@@ -54,6 +55,7 @@ const validPromptTypes = new Set([
 	"password",
 	"editor",
 	"select",
+	"search",
 	"rawlist",
 	"expand",
 	"checkbox"
@@ -165,6 +167,16 @@ async function executePromptRaw(config, context) {
 					...cfg.default !== void 0 ? { default: cfg.default } : {}
 				}, inquirerContext)
 			};
+			case "search": return {
+				success: true,
+				value: await prompts.search({
+					message: cfg.message,
+					source: async (term, sourceContext) => normalizeChoices(await cfg.source(term, sourceContext)),
+					...cfg.default === void 0 ? {} : { default: cfg.default },
+					...cfg.pageSize === void 0 ? {} : { pageSize: cfg.pageSize },
+					...cfg.validate === void 0 ? {} : { validate: cfg.validate }
+				}, inquirerContext)
+			};
 			case "rawlist": return {
 				success: true,
 				value: await prompts.rawlist({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/inquirer",
-  "version": "1.4.0-dev.2728",
+  "version": "1.4.0-dev.2731",
   "description": "Inquirer.js prompt support for Optique",
   "keywords": [
     "CLI",
@@ -62,13 +62,13 @@
   "sideEffects": false,
   "dependencies": {
     "@inquirer/prompts": "^8.3.0",
-    "@optique/core": "1.4.0-dev.2728+5829a43f",
-    "@optique/prompt": "1.4.0-dev.2728+5829a43f"
+    "@optique/core": "1.4.0-dev.2731+078a644e",
+    "@optique/prompt": "1.4.0-dev.2731+078a644e"
   },
   "devDependencies": {
-    "@optique/config": "1.4.0-dev.2728+5829a43f",
-    "@optique/env": "1.4.0-dev.2728+5829a43f",
-    "@optique/run": "1.4.0-dev.2728+5829a43f",
+    "@optique/config": "1.4.0-dev.2731+078a644e",
+    "@optique/env": "1.4.0-dev.2731+078a644e",
+    "@optique/run": "1.4.0-dev.2731+078a644e",
     "@types/node": "^24.0.0",
     "fast-check": "^4.7.0",
     "tsdown": "^0.13.0",