@optique/clack 1.4.0-dev.2728 → 1.4.0-dev.2729

package/dist/index.cjs

@@ -28,6 +28,8 @@ const __optique_prompt = __toESM(require("@optique/prompt"));
 //#region src/index.ts
 const promptFunctionsOverrideSymbol = Symbol.for("@optique/clack/prompt-functions");
 const defaultPromptFunctions = {
+	autocomplete: __clack_prompts.autocomplete,
+	autocompleteMultiselect: __clack_prompts.autocompleteMultiselect,
 	spinner: __clack_prompts.spinner,
 	text: __clack_prompts.text,
 	password: __clack_prompts.password,
@@ -132,7 +134,18 @@ async function executePromptRaw(config, context) {
 	if ("prompter" in cfg && cfg.prompter != null) result = await cfg.prompter(context);
 	else {
 		if (context.previousValidationMessage !== void 0) prompts.logError((0, __optique_core_message.formatMessage)(context.previousValidationMessage));
-		result = await executeClackPromptWithSignal(cfg, prompts, context.signal);
+		const disabled = cfg.type === "autocomplete-multiselect" ? new Set(normalizeOptions(cfg.options).filter((option) => option.disabled).map((option) => option.value)) : void 0;
+		while (true) {
+			result = await executeClackPromptWithSignal(cfg, prompts, context.signal);
+			if (cfg.type !== "autocomplete-multiselect" || disabled === void 0 || !Array.isArray(result)) break;
+			const values = result.filter((value) => typeof value !== "string" || !disabled.has(value));
+			if (cfg.required === true && result.length > 0 && values.length === 0) {
+				prompts.logError("No option selected.");
+				continue;
+			}
+			result = values;
+			break;
+		}
 	}
 	if (prompts.isCancel(result)) {
 		if (context.signal?.aborted === true) throw context.signal.reason;
@@ -142,7 +155,11 @@ async function executePromptRaw(config, context) {
 		};
 	}
 	if (cfg.type === "number") return normalizeNumberResult(result);
-	if (cfg.type === "multiselect") return normalizeMultiselectResult(result, cfg);
+	if (cfg.type === "autocomplete" && typeof result !== "string") return {
+		success: false,
+		error: __optique_core_message.message`No option selected.`
+	};
+	if (cfg.type === "multiselect" || cfg.type === "autocomplete-multiselect") return normalizeMultiselectResult(result, cfg);
 	return {
 		success: true,
 		value: result
@@ -161,7 +178,7 @@ async function executeClackPromptWithSignal(cfg, prompts, signal) {
 	}
 }
 function isPromptType(value) {
-	return value === "text" || value === "password" || value === "confirm" || value === "number" || value === "select" || value === "multiselect";
+	return value === "text" || value === "password" || value === "confirm" || value === "number" || value === "select" || value === "multiselect" || value === "autocomplete" || value === "autocomplete-multiselect";
 }
 function executeClackPrompt(cfg, prompts, signal) {
 	switch (cfg.type) {
@@ -202,6 +219,34 @@ function executeClackPrompt(cfg, prompts, signal) {
 			options: normalizeOptions(cfg.options),
 			...cfg.initialValue !== void 0 ? { initialValue: cfg.initialValue } : {}
 		});
+		case "autocomplete": {
+			const options = normalizeOptions(cfg.options);
+			return prompts.autocomplete({
+				message: cfg.message,
+				options,
+				...signal === void 0 ? {} : { signal },
+				...cfg.initialValue === void 0 ? {} : { initialValue: cfg.initialValue },
+				...cfg.initialUserInput === void 0 ? {} : { initialUserInput: cfg.initialUserInput },
+				...cfg.placeholder === void 0 ? {} : { placeholder: cfg.placeholder },
+				...cfg.maxItems === void 0 ? {} : { maxItems: cfg.maxItems },
+				...cfg.filter === void 0 ? {} : { filter: cfg.filter },
+				validate: (value) => {
+					if (typeof value !== "string") return "No option selected.";
+					if (options.some((option) => option.value === value && option.disabled)) return "Option is unavailable.";
+					return cfg.validate?.(value) ?? void 0;
+				}
+			});
+		}
+		case "autocomplete-multiselect": return prompts.autocompleteMultiselect({
+			message: cfg.message,
+			options: normalizeOptions(cfg.options),
+			...signal === void 0 ? {} : { signal },
+			...cfg.initialValues === void 0 ? {} : { initialValues: [...cfg.initialValues] },
+			...cfg.required === void 0 ? {} : { required: cfg.required },
+			...cfg.placeholder === void 0 ? {} : { placeholder: cfg.placeholder },
+			...cfg.maxItems === void 0 ? {} : { maxItems: cfg.maxItems },
+			...cfg.filter === void 0 ? {} : { filter: cfg.filter }
+		});
 		case "multiselect": return prompts.multiselect({
 			message: cfg.message,
 			...signal === void 0 ? {} : { signal },

package/dist/index.d.cts

@@ -5,7 +5,7 @@ import { DerivePromptConfigContext, DerivePromptConfigNoDepsContext, DerivePromp
 //#region src/index.d.ts
 
 /**
- * A choice item for `select` and `multiselect` prompts.
+ * A choice item for selection and autocomplete prompts.
  *
  * @since 1.2.0
  */
@@ -150,12 +150,58 @@ interface MultiselectConfig {
    */
   readonly prompter?: (context: PromptExecutionContext$1) => Promise<readonly string[]>;
 }
+/** Shared settings for filtering a list of options. */
+interface AutocompleteSettings {
+  /** The question to display to the user. */
+  readonly message: string;
+  /** Available options. Use a derived config to load them lazily. */
+  readonly options: readonly (string | Option)[];
+  /** Hint text shown when the search input is empty. */
+  readonly placeholder?: string;
+  /** Maximum number of options displayed at once. */
+  readonly maxItems?: number;
+  /** Matches search input against a normalized option. */
+  readonly filter?: (search: string, option: Option) => boolean;
+}
+/**
+ * Configuration for an `autocomplete` prompt that filters a local list.
+ *
+ * @since 1.4.0
+ */
+interface AutocompleteConfig extends AutocompleteSettings {
+  readonly type: "autocomplete";
+  /** Initially selected option value. */
+  readonly initialValue?: string;
+  /** Initial text in the search input. */
+  readonly initialUserInput?: string;
+  /** Synchronous validation of the selected value inside the prompt. */
+  readonly validate?: (value: string) => string | void;
+  /** Overrides prompt execution. Useful for testing. */
+  readonly prompter?: (context: PromptExecutionContext$1) => Promise<string>;
+}
+/**
+ * Configuration for an `autocomplete-multiselect` prompt.
+ *
+ * Use shared prompt options for validation; Clack does not run a custom
+ * validator for this prompt type.
+ *
+ * @since 1.4.0
+ */
+interface AutocompleteMultiselectConfig extends AutocompleteSettings {
+  readonly type: "autocomplete-multiselect";
+  /** Initially selected option values. */
+  readonly initialValues?: readonly string[];
+  /** Whether at least one option must be selected. */
+  readonly required?: boolean;
+  /** Overrides prompt execution. Useful for testing. */
+  readonly prompter?: (context: PromptExecutionContext$1) => Promise<readonly string[]>;
+}
 /**
  * A union of all string-valued prompt configurations.
  *
  * @since 1.2.0
  */
-type StringPromptConfig = TextConfig | PasswordConfig | SelectConfig;
+type StringPromptConfig = TextConfig | PasswordConfig | SelectConfig | AutocompleteConfig;
 /**
  * Type-safe Clack prompt configuration for a given parser value type `T`.
  *
@@ -163,7 +209,7 @@ type StringPromptConfig = TextConfig | PasswordConfig | SelectConfig;
  * @since 1.3.0 Added conditional prompt skipping.
  */
 type PromptConfig<T> = BasePromptConfig<Exclude<T, null | undefined>> & PromptCondition<T>;
-type BasePromptConfig<T> = T extends boolean ? ConfirmConfig : T extends number ? NumberPromptConfig : T extends string ? StringPromptConfig : T extends readonly string[] ? MultiselectConfig : never;
+type BasePromptConfig<T> = T extends boolean ? ConfirmConfig : T extends number ? NumberPromptConfig : T extends string ? StringPromptConfig : T extends readonly string[] ? MultiselectConfig | AutocompleteMultiselectConfig : never;
 /**
  * Union of every prompt configuration this package can execute,
  * regardless of the parser value type.
@@ -175,7 +221,7 @@ type BasePromptConfig<T> = T extends boolean ? ConfirmConfig : T extends number
  *
  * @since 1.3.0
  */
-type RuntimePromptConfig = ConfirmConfig | NumberPromptConfig | StringPromptConfig | MultiselectConfig;
+type RuntimePromptConfig = ConfirmConfig | NumberPromptConfig | StringPromptConfig | MultiselectConfig | AutocompleteMultiselectConfig;
 /**
  * Shared prompt options and Clack's derived configuration pending indicator.
  *
@@ -213,4 +259,4 @@ interface ClackPromptOptions<TValue> extends PromptOptions$1<TValue> {
  */
 declare function prompt<M extends Mode, TValue, TState>(parser: Parser<M, TValue, TState>, config: PromptConfig<TValue> | DerivedPromptConfig$1<RuntimePromptConfig, NoInfer<TValue>>, options?: ClackPromptOptions<NoInfer<TValue>>): FluentParser<"async", TValue, TState>;
 //#endregion
-export { ClackPromptOptions, ConfirmConfig, type DerivePromptConfigContext, type DerivePromptConfigNoDepsContext, type DerivePromptConfigNoDepsOptions, type DerivePromptConfigOptions, type DerivePromptConfigsContext, type DerivePromptConfigsOptions, type DerivedPromptConfig, MultiselectConfig, NumberPromptConfig, Option, PasswordConfig, PromptConfig, type PromptExecutionContext, type PromptOptions, type PromptValidator, RuntimePromptConfig, SelectConfig, StringPromptConfig, TextConfig, derivePromptConfig, isDerivedPromptConfig, prompt };
+export { AutocompleteConfig, AutocompleteMultiselectConfig, ClackPromptOptions, ConfirmConfig, type DerivePromptConfigContext, type DerivePromptConfigNoDepsContext, type DerivePromptConfigNoDepsOptions, type DerivePromptConfigOptions, type DerivePromptConfigsContext, type DerivePromptConfigsOptions, type DerivedPromptConfig, MultiselectConfig, NumberPromptConfig, Option, PasswordConfig, PromptConfig, type PromptExecutionContext, type PromptOptions, type PromptValidator, RuntimePromptConfig, SelectConfig, StringPromptConfig, TextConfig, derivePromptConfig, isDerivedPromptConfig, prompt };

package/dist/index.d.ts

@@ -5,7 +5,7 @@ import { Mode, Parser } from "@optique/core/parser";
 //#region src/index.d.ts
 
 /**
- * A choice item for `select` and `multiselect` prompts.
+ * A choice item for selection and autocomplete prompts.
  *
  * @since 1.2.0
  */
@@ -150,12 +150,58 @@ interface MultiselectConfig {
    */
   readonly prompter?: (context: PromptExecutionContext$1) => Promise<readonly string[]>;
 }
+/** Shared settings for filtering a list of options. */
+interface AutocompleteSettings {
+  /** The question to display to the user. */
+  readonly message: string;
+  /** Available options. Use a derived config to load them lazily. */
+  readonly options: readonly (string | Option)[];
+  /** Hint text shown when the search input is empty. */
+  readonly placeholder?: string;
+  /** Maximum number of options displayed at once. */
+  readonly maxItems?: number;
+  /** Matches search input against a normalized option. */
+  readonly filter?: (search: string, option: Option) => boolean;
+}
+/**
+ * Configuration for an `autocomplete` prompt that filters a local list.
+ *
+ * @since 1.4.0
+ */
+interface AutocompleteConfig extends AutocompleteSettings {
+  readonly type: "autocomplete";
+  /** Initially selected option value. */
+  readonly initialValue?: string;
+  /** Initial text in the search input. */
+  readonly initialUserInput?: string;
+  /** Synchronous validation of the selected value inside the prompt. */
+  readonly validate?: (value: string) => string | void;
+  /** Overrides prompt execution. Useful for testing. */
+  readonly prompter?: (context: PromptExecutionContext$1) => Promise<string>;
+}
+/**
+ * Configuration for an `autocomplete-multiselect` prompt.
+ *
+ * Use shared prompt options for validation; Clack does not run a custom
+ * validator for this prompt type.
+ *
+ * @since 1.4.0
+ */
+interface AutocompleteMultiselectConfig extends AutocompleteSettings {
+  readonly type: "autocomplete-multiselect";
+  /** Initially selected option values. */
+  readonly initialValues?: readonly string[];
+  /** Whether at least one option must be selected. */
+  readonly required?: boolean;
+  /** Overrides prompt execution. Useful for testing. */
+  readonly prompter?: (context: PromptExecutionContext$1) => Promise<readonly string[]>;
+}
 /**
  * A union of all string-valued prompt configurations.
  *
  * @since 1.2.0
  */
-type StringPromptConfig = TextConfig | PasswordConfig | SelectConfig;
+type StringPromptConfig = TextConfig | PasswordConfig | SelectConfig | AutocompleteConfig;
 /**
  * Type-safe Clack prompt configuration for a given parser value type `T`.
  *
@@ -163,7 +209,7 @@ type StringPromptConfig = TextConfig | PasswordConfig | SelectConfig;
  * @since 1.3.0 Added conditional prompt skipping.
  */
 type PromptConfig<T> = BasePromptConfig<Exclude<T, null | undefined>> & PromptCondition<T>;
-type BasePromptConfig<T> = T extends boolean ? ConfirmConfig : T extends number ? NumberPromptConfig : T extends string ? StringPromptConfig : T extends readonly string[] ? MultiselectConfig : never;
+type BasePromptConfig<T> = T extends boolean ? ConfirmConfig : T extends number ? NumberPromptConfig : T extends string ? StringPromptConfig : T extends readonly string[] ? MultiselectConfig | AutocompleteMultiselectConfig : never;
 /**
  * Union of every prompt configuration this package can execute,
  * regardless of the parser value type.
@@ -175,7 +221,7 @@ type BasePromptConfig<T> = T extends boolean ? ConfirmConfig : T extends number
  *
  * @since 1.3.0
  */
-type RuntimePromptConfig = ConfirmConfig | NumberPromptConfig | StringPromptConfig | MultiselectConfig;
+type RuntimePromptConfig = ConfirmConfig | NumberPromptConfig | StringPromptConfig | MultiselectConfig | AutocompleteMultiselectConfig;
 /**
  * Shared prompt options and Clack's derived configuration pending indicator.
  *
@@ -213,4 +259,4 @@ interface ClackPromptOptions<TValue> extends PromptOptions$1<TValue> {
  */
 declare function prompt<M extends Mode, TValue, TState>(parser: Parser<M, TValue, TState>, config: PromptConfig<TValue> | DerivedPromptConfig$1<RuntimePromptConfig, NoInfer<TValue>>, options?: ClackPromptOptions<NoInfer<TValue>>): FluentParser<"async", TValue, TState>;
 //#endregion
-export { ClackPromptOptions, ConfirmConfig, type DerivePromptConfigContext, type DerivePromptConfigNoDepsContext, type DerivePromptConfigNoDepsOptions, type DerivePromptConfigOptions, type DerivePromptConfigsContext, type DerivePromptConfigsOptions, type DerivedPromptConfig, MultiselectConfig, NumberPromptConfig, Option, PasswordConfig, PromptConfig, type PromptExecutionContext, type PromptOptions, type PromptValidator, RuntimePromptConfig, SelectConfig, StringPromptConfig, TextConfig, derivePromptConfig, isDerivedPromptConfig, prompt };
+export { AutocompleteConfig, AutocompleteMultiselectConfig, ClackPromptOptions, ConfirmConfig, type DerivePromptConfigContext, type DerivePromptConfigNoDepsContext, type DerivePromptConfigNoDepsOptions, type DerivePromptConfigOptions, type DerivePromptConfigsContext, type DerivePromptConfigsOptions, type DerivedPromptConfig, MultiselectConfig, NumberPromptConfig, Option, PasswordConfig, PromptConfig, type PromptExecutionContext, type PromptOptions, type PromptValidator, RuntimePromptConfig, SelectConfig, StringPromptConfig, TextConfig, derivePromptConfig, isDerivedPromptConfig, prompt };

package/dist/index.js

@@ -1,10 +1,12 @@
-import { confirm, isCancel, log, multiselect, password, select, spinner, text } from "@clack/prompts";
+import { autocomplete, autocompleteMultiselect, confirm, isCancel, log, multiselect, password, select, spinner, text } from "@clack/prompts";
 import { formatMessage, message } from "@optique/core/message";
 import { createPromptAdapter, derivePromptConfig, isDerivedPromptConfig } from "@optique/prompt";
 
 //#region src/index.ts
 const promptFunctionsOverrideSymbol = Symbol.for("@optique/clack/prompt-functions");
 const defaultPromptFunctions = {
+	autocomplete,
+	autocompleteMultiselect,
 	spinner,
 	text,
 	password,
@@ -109,7 +111,18 @@ async function executePromptRaw(config, context) {
 	if ("prompter" in cfg && cfg.prompter != null) result = await cfg.prompter(context);
 	else {
 		if (context.previousValidationMessage !== void 0) prompts.logError(formatMessage(context.previousValidationMessage));
-		result = await executeClackPromptWithSignal(cfg, prompts, context.signal);
+		const disabled = cfg.type === "autocomplete-multiselect" ? new Set(normalizeOptions(cfg.options).filter((option) => option.disabled).map((option) => option.value)) : void 0;
+		while (true) {
+			result = await executeClackPromptWithSignal(cfg, prompts, context.signal);
+			if (cfg.type !== "autocomplete-multiselect" || disabled === void 0 || !Array.isArray(result)) break;
+			const values = result.filter((value) => typeof value !== "string" || !disabled.has(value));
+			if (cfg.required === true && result.length > 0 && values.length === 0) {
+				prompts.logError("No option selected.");
+				continue;
+			}
+			result = values;
+			break;
+		}
 	}
 	if (prompts.isCancel(result)) {
 		if (context.signal?.aborted === true) throw context.signal.reason;
@@ -119,7 +132,11 @@ async function executePromptRaw(config, context) {
 		};
 	}
 	if (cfg.type === "number") return normalizeNumberResult(result);
-	if (cfg.type === "multiselect") return normalizeMultiselectResult(result, cfg);
+	if (cfg.type === "autocomplete" && typeof result !== "string") return {
+		success: false,
+		error: message`No option selected.`
+	};
+	if (cfg.type === "multiselect" || cfg.type === "autocomplete-multiselect") return normalizeMultiselectResult(result, cfg);
 	return {
 		success: true,
 		value: result
@@ -138,7 +155,7 @@ async function executeClackPromptWithSignal(cfg, prompts, signal) {
 	}
 }
 function isPromptType(value) {
-	return value === "text" || value === "password" || value === "confirm" || value === "number" || value === "select" || value === "multiselect";
+	return value === "text" || value === "password" || value === "confirm" || value === "number" || value === "select" || value === "multiselect" || value === "autocomplete" || value === "autocomplete-multiselect";
 }
 function executeClackPrompt(cfg, prompts, signal) {
 	switch (cfg.type) {
@@ -179,6 +196,34 @@ function executeClackPrompt(cfg, prompts, signal) {
 			options: normalizeOptions(cfg.options),
 			...cfg.initialValue !== void 0 ? { initialValue: cfg.initialValue } : {}
 		});
+		case "autocomplete": {
+			const options = normalizeOptions(cfg.options);
+			return prompts.autocomplete({
+				message: cfg.message,
+				options,
+				...signal === void 0 ? {} : { signal },
+				...cfg.initialValue === void 0 ? {} : { initialValue: cfg.initialValue },
+				...cfg.initialUserInput === void 0 ? {} : { initialUserInput: cfg.initialUserInput },
+				...cfg.placeholder === void 0 ? {} : { placeholder: cfg.placeholder },
+				...cfg.maxItems === void 0 ? {} : { maxItems: cfg.maxItems },
+				...cfg.filter === void 0 ? {} : { filter: cfg.filter },
+				validate: (value) => {
+					if (typeof value !== "string") return "No option selected.";
+					if (options.some((option) => option.value === value && option.disabled)) return "Option is unavailable.";
+					return cfg.validate?.(value) ?? void 0;
+				}
+			});
+		}
+		case "autocomplete-multiselect": return prompts.autocompleteMultiselect({
+			message: cfg.message,
+			options: normalizeOptions(cfg.options),
+			...signal === void 0 ? {} : { signal },
+			...cfg.initialValues === void 0 ? {} : { initialValues: [...cfg.initialValues] },
+			...cfg.required === void 0 ? {} : { required: cfg.required },
+			...cfg.placeholder === void 0 ? {} : { placeholder: cfg.placeholder },
+			...cfg.maxItems === void 0 ? {} : { maxItems: cfg.maxItems },
+			...cfg.filter === void 0 ? {} : { filter: cfg.filter }
+		});
 		case "multiselect": return prompts.multiselect({
 			message: cfg.message,
 			...signal === void 0 ? {} : { signal },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/clack",
-  "version": "1.4.0-dev.2728",
+  "version": "1.4.0-dev.2729",
   "description": "Interactive prompt support for Optique via Clack",
   "keywords": [
     "CLI",
@@ -62,12 +62,12 @@
   "sideEffects": false,
   "dependencies": {
     "@clack/prompts": "^1.6.0",
-    "@optique/core": "1.4.0-dev.2728+5829a43f",
-    "@optique/prompt": "1.4.0-dev.2728+5829a43f"
+    "@optique/core": "1.4.0-dev.2729+72048695",
+    "@optique/prompt": "1.4.0-dev.2729+72048695"
   },
   "devDependencies": {
-    "@optique/env": "1.4.0-dev.2728+5829a43f",
-    "@optique/run": "1.4.0-dev.2728+5829a43f",
+    "@optique/env": "1.4.0-dev.2729+72048695",
+    "@optique/run": "1.4.0-dev.2729+72048695",
     "@types/node": "^24.0.0",
     "fast-check": "^4.7.0",
     "tsdown": "^0.13.0",