@optique/inquirer 1.2.0-dev.2188 → 1.2.0-dev.2192

package/README.md

@@ -1,18 +1,18 @@
 @optique/inquirer
 =================
 
-Interactive prompt support for [Optique] via [Inquirer.js].
+[Inquirer.js] prompt support for [Optique].
 
 This package wraps any Optique parser with an interactive prompt that fires
 when no CLI value is provided.  The fallback priority is:
 
-CLI arguments > interactive prompt.
+CLI arguments > Inquirer.js prompt.
 
 Because interactive prompts are inherently asynchronous, the returned parser
 always has `mode: "async"`.
 
-[Optique]: https://optique.dev/
 [Inquirer.js]: https://github.com/SBoudrias/Inquirer.js
+[Optique]: https://optique.dev/
 
 
 Installation
@@ -53,7 +53,7 @@ await run(parser);
 ~~~~
 
 When `--name` and `--port` are provided on the command line, the prompts are
-skipped.  When they are absent, the user sees interactive prompts.
+skipped.  When they are absent, the user sees Inquirer.js prompts.
 
 
 Features

package/dist/index.cjs

@@ -22,10 +22,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 
 //#endregion
 const __inquirer_prompts = __toESM(require("@inquirer/prompts"));
-const __optique_core_annotations = __toESM(require("@optique/core/annotations"));
-const __optique_core_extension = __toESM(require("@optique/core/extension"));
-const __optique_core_fluent = __toESM(require("@optique/core/fluent"));
 const __optique_core_message = __toESM(require("@optique/core/message"));
+const __optique_prompt = __toESM(require("@optique/prompt"));
 
 //#region src/index.ts
 const promptFunctionsOverrideSymbol = Symbol.for("@optique/inquirer/prompt-functions");
@@ -71,406 +69,146 @@ function getPromptFunctions() {
 function isExitPromptError(error) {
 	return typeof error === "object" && error != null && "name" in error && error.name === "ExitPromptError";
 }
-function shouldDeferPrompt(parser, state, exec) {
-	return typeof parser.shouldDeferCompletion === "function" && parser.shouldDeferCompletion(state, exec) === true;
-}
-function deferredPromptResult(placeholderValue) {
-	if (placeholderValue == null || typeof placeholderValue !== "object") return {
-		success: true,
-		value: placeholderValue,
-		deferred: true
-	};
-	const isArray = Array.isArray(placeholderValue);
-	const keys = /* @__PURE__ */ new Map();
-	for (const key of Reflect.ownKeys(placeholderValue)) {
-		if (isArray && key === "length") continue;
-		keys.set(key, null);
-	}
-	return {
-		success: true,
-		value: placeholderValue,
-		deferred: true,
-		deferredKeys: keys
-	};
-}
-function withAnnotatedInnerState(sourceState, innerState, run) {
-	const annotations = (0, __optique_core_annotations.getAnnotations)(sourceState);
-	if (annotations == null || innerState == null || typeof innerState !== "object" || (0, __optique_core_annotations.getAnnotations)(innerState) != null) return run(innerState);
-	const inheritedState = (0, __optique_core_extension.inheritAnnotations)(sourceState, innerState);
-	if (inheritedState !== innerState) return run(inheritedState);
-	return run((0, __optique_core_extension.withAnnotationView)(innerState, annotations));
-}
+const validPromptTypes = new Set([
+	"confirm",
+	"number",
+	"input",
+	"password",
+	"editor",
+	"select",
+	"rawlist",
+	"expand",
+	"checkbox"
+]);
 /**
 * Wraps a parser with an interactive Inquirer.js prompt fallback.
 *
-* When the inner parser finds a value in the CLI arguments (consumed tokens),
-* that value is used directly. When no CLI value is found, an interactive
-* prompt is shown to the user.
-*
-* The returned parser always has `mode: "async"` because Inquirer.js prompts
-* are inherently asynchronous.
-*
-* Example:
-*
-* ```typescript
-* import { option } from "@optique/core/primitives";
-* import { string } from "@optique/core/valueparser";
-* import { prompt } from "@optique/inquirer";
-*
-* const nameParser = prompt(option("--name", string()), {
-*   type: "input",
-*   message: "Enter your name:",
-* });
-* ```
+* When the inner parser finds a value in the CLI arguments, that value is used
+* directly.  When no CLI value is found, an interactive prompt is shown to the
+* user.
 *
 * @param parser Inner parser that reads CLI values.
 * @param config Type-safe Inquirer.js prompt configuration.
 * @returns A parser with interactive prompt fallback, always in async mode.
-* @throws {Error} If prompt execution fails with an unexpected error or if
-*                 the inner parser throws while parsing or completing.
+* @throws {Error} If prompt execution fails with an unexpected error or if the
+*                 inner parser throws while parsing or completing.
 * @since 1.0.0
 */
 function prompt(parser, config) {
-	const promptBindStateKey = Symbol("@optique/inquirer/promptState");
-	function isPromptBindState(value) {
-		return value != null && typeof value === "object" && promptBindStateKey in value;
-	}
+	const promptWithAdapter = (0, __optique_prompt.createPromptAdapter)({
+		execute: (cfg) => executePromptRaw(cfg),
+		getDefaultValue: getConfigDefault
+	});
+	return promptWithAdapter(parser, config);
+}
+function getConfigDefault(config) {
+	if (config != null && typeof config === "object" && "default" in config) return config.default;
+	return void 0;
+}
+async function executePromptRaw(config) {
 	const cfg = config;
-	function shouldAttemptInnerCompletion(cliState, state) {
-		if (cliState == null) return false;
-		const cliStateHasAnnotations = (0, __optique_core_annotations.getAnnotations)(cliState) != null;
-		if (cliStateHasAnnotations) return true;
-		if ((0, __optique_core_annotations.getAnnotations)(state) == null || typeof cliState !== "object") return false;
-		if ("hasCliValue" in cliState) return true;
-		if (Array.isArray(cliState)) return typeof parser.shouldDeferCompletion === "function";
-		const prototype = Object.getPrototypeOf(cliState);
-		return prototype !== Object.prototype && prototype !== null;
-	}
-	function hasSourceBindingMarker(state) {
-		return state != null && typeof state === "object" && "hasCliValue" in state && Object.getOwnPropertySymbols(state).length > 0;
-	}
-	function shouldCompleteFromSourceBinding(cliState, state) {
-		const cliStateIsInjectedAnnotationWrapper = cliState != null && typeof cliState === "object" && (0, __optique_core_extension.unwrapInjectedAnnotationState)(cliState) !== cliState;
-		const requiresSourceBindingForAnnotationWrapper = (0, __optique_core_extension.getTraits)(parser).requiresSourceBinding === true;
-		const hasNestedSourceBinding = hasSourceBindingMarker(cliState) || Array.isArray(cliState) && cliState.length === 1 && (hasSourceBindingMarker(cliState[0]) || cliState[0] != null && typeof cliState[0] === "object" && (0, __optique_core_annotations.getAnnotations)(cliState[0]) != null);
-		if (cliStateIsInjectedAnnotationWrapper && requiresSourceBindingForAnnotationWrapper) return hasNestedSourceBinding;
-		return shouldAttemptInnerCompletion(cliState, state) || hasNestedSourceBinding;
-	}
-	/**
-	* Executes the configured prompt and normalizes its result.
-	*
-	* Converts `ExitPromptError` into a parse failure and returns prompt values
-	* in Optique's `ValueParserResult` shape.
-	*
-	* @returns The normalized prompt result.
-	* @throws {Error} Rethrows unexpected prompt failures after converting
-	*                 `ExitPromptError` cancellations into parse failures.
-	*/
-	function validatePromptedValue(result) {
-		return result;
-	}
-	const validPromptTypes = new Set([
-		"confirm",
-		"number",
-		"input",
-		"password",
-		"editor",
-		"select",
-		"rawlist",
-		"expand",
-		"checkbox"
-	]);
-	async function executePromptRaw() {
-		const prompts = getPromptFunctions();
-		try {
-			if (!validPromptTypes.has(cfg.type)) throw new TypeError(`Unsupported prompt type: ${cfg.type}`);
-			if ("prompter" in cfg && cfg.prompter != null) {
-				const value = await cfg.prompter();
-				if (cfg.type === "number" && value === void 0) return {
+	const prompts = getPromptFunctions();
+	try {
+		if (!validPromptTypes.has(cfg.type)) throw new TypeError(`Unsupported prompt type: ${cfg.type}`);
+		if ("prompter" in cfg && cfg.prompter != null) {
+			const value = await cfg.prompter();
+			if (cfg.type === "number" && value === void 0) return {
+				success: false,
+				error: __optique_core_message.message`No number provided.`
+			};
+			return {
+				success: true,
+				value
+			};
+		}
+		switch (cfg.type) {
+			case "confirm": return {
+				success: true,
+				value: await prompts.confirm({
+					message: cfg.message,
+					...cfg.default !== void 0 ? { default: cfg.default } : {}
+				})
+			};
+			case "number": {
+				const numResult = await prompts.number({
+					message: cfg.message,
+					...cfg.default !== void 0 ? { default: cfg.default } : {},
+					...cfg.min !== void 0 ? { min: cfg.min } : {},
+					...cfg.max !== void 0 ? { max: cfg.max } : {},
+					...cfg.step !== void 0 ? { step: cfg.step } : {}
+				});
+				if (numResult === void 0) return {
 					success: false,
 					error: __optique_core_message.message`No number provided.`
 				};
 				return {
 					success: true,
-					value
+					value: numResult
 				};
 			}
-			switch (cfg.type) {
-				case "confirm": return {
-					success: true,
-					value: await prompts.confirm({
-						message: cfg.message,
-						...cfg.default !== void 0 ? { default: cfg.default } : {}
-					})
-				};
-				case "number": {
-					const numResult = await prompts.number({
-						message: cfg.message,
-						...cfg.default !== void 0 ? { default: cfg.default } : {},
-						...cfg.min !== void 0 ? { min: cfg.min } : {},
-						...cfg.max !== void 0 ? { max: cfg.max } : {},
-						...cfg.step !== void 0 ? { step: cfg.step } : {}
-					});
-					if (numResult === void 0) return {
-						success: false,
-						error: __optique_core_message.message`No number provided.`
-					};
-					return {
-						success: true,
-						value: numResult
-					};
-				}
-				case "input": return {
-					success: true,
-					value: await prompts.input({
-						message: cfg.message,
-						...cfg.default !== void 0 ? { default: cfg.default } : {},
-						...cfg.validate !== void 0 ? { validate: cfg.validate } : {}
-					})
-				};
-				case "password": return {
-					success: true,
-					value: await prompts.password({
-						message: cfg.message,
-						...cfg.mask !== void 0 ? { mask: cfg.mask } : {},
-						...cfg.validate !== void 0 ? { validate: cfg.validate } : {}
-					})
-				};
-				case "editor": return {
-					success: true,
-					value: await prompts.editor({
-						message: cfg.message,
-						...cfg.default !== void 0 ? { default: cfg.default } : {},
-						...cfg.validate !== void 0 ? { validate: cfg.validate } : {}
-					})
-				};
-				case "select": return {
-					success: true,
-					value: await prompts.select({
-						message: cfg.message,
-						choices: normalizeChoices(cfg.choices),
-						...cfg.default !== void 0 ? { default: cfg.default } : {}
-					})
-				};
-				case "rawlist": return {
-					success: true,
-					value: await prompts.rawlist({
-						message: cfg.message,
-						choices: normalizeChoices(cfg.choices),
-						...cfg.default !== void 0 ? { default: cfg.default } : {}
-					})
-				};
-				case "expand": return {
-					success: true,
-					value: await prompts.expand({
-						message: cfg.message,
-						choices: cfg.choices,
-						...cfg.default !== void 0 ? { default: cfg.default } : {}
-					})
-				};
-				case "checkbox": return {
-					success: true,
-					value: await prompts.checkbox({
-						message: cfg.message,
-						choices: normalizeChoices(cfg.choices)
-					})
-				};
-			}
-		} catch (error) {
-			if (isExitPromptError(error)) return {
-				success: false,
-				error: __optique_core_message.message`Prompt cancelled.`
+			case "input": return {
+				success: true,
+				value: await prompts.input({
+					message: cfg.message,
+					...cfg.default !== void 0 ? { default: cfg.default } : {},
+					...cfg.validate !== void 0 ? { validate: cfg.validate } : {}
+				})
 			};
-			throw error;
-		}
-	}
-	async function executePrompt() {
-		const result = await executePromptRaw();
-		return validatePromptedValue(result);
-	}
-	const promptedParser = {
-		mode: "async",
-		$valueType: parser.$valueType,
-		$stateType: parser.$stateType,
-		priority: parser.priority,
-		usage: parser.usage.length === 1 && parser.usage[0].type === "optional" ? parser.usage : [{
-			type: "optional",
-			terms: parser.usage
-		}],
-		leadingNames: parser.leadingNames,
-		acceptingAnyToken: parser.acceptingAnyToken,
-		shouldDeferCompletion(state) {
-			return !isPromptBindState(state) || !state.hasCliValue;
-		},
-		getSuggestRuntimeNodes(state, path) {
-			const innerState = isPromptBindState(state) ? state.cliState === void 0 ? parser.initialState : state.cliState : state;
-			return (0, __optique_core_extension.delegateSuggestNodes)(parser, promptedParser, state, path, innerState, "prepend");
-		},
-		initialState: {
-			[promptBindStateKey]: true,
-			hasCliValue: false
-		},
-		parse: (context) => {
-			const annotations = (0, __optique_core_annotations.getAnnotations)(context.state);
-			const innerState = isPromptBindState(context.state) ? context.state.hasCliValue ? context.state.cliState : parser.initialState : context.state;
-			const baseInnerContext = innerState !== context.state ? {
-				...context,
-				state: innerState
-			} : context;
-			const effectiveInnerState = annotations != null && innerState == null && (0, __optique_core_extension.getTraits)(parser).inheritsAnnotations === true ? (0, __optique_core_extension.injectAnnotations)(innerState, annotations) : innerState;
-			const processResult = (result$1) => {
-				if (result$1.success) {
-					const cliState = annotations != null && result$1.next.state != null && typeof result$1.next.state === "object" && (0, __optique_core_annotations.getAnnotations)(result$1.next.state) !== annotations ? (0, __optique_core_extension.injectAnnotations)(result$1.next.state, annotations) : result$1.next.state;
-					const cliConsumed = result$1.consumed.length > 0;
-					const nextState$1 = (0, __optique_core_extension.injectAnnotations)({
-						[promptBindStateKey]: true,
-						hasCliValue: cliConsumed,
-						cliState
-					}, annotations);
-					return {
-						success: true,
-						...result$1.provisional ? { provisional: true } : {},
-						next: {
-							...result$1.next,
-							state: nextState$1
-						},
-						consumed: result$1.consumed
-					};
-				}
-				if (result$1.consumed > 0) return result$1;
-				const nextState = (0, __optique_core_extension.injectAnnotations)({
-					[promptBindStateKey]: true,
-					hasCliValue: false
-				}, annotations);
-				return {
-					success: true,
-					next: {
-						...baseInnerContext,
-						state: nextState
-					},
-					consumed: []
-				};
+			case "password": return {
+				success: true,
+				value: await prompts.password({
+					message: cfg.message,
+					...cfg.mask !== void 0 ? { mask: cfg.mask } : {},
+					...cfg.validate !== void 0 ? { validate: cfg.validate } : {}
+				})
 			};
-			const result = withAnnotatedInnerState(context.state, effectiveInnerState, (annotatedInnerState) => {
-				const innerContext = annotatedInnerState !== context.state ? {
-					...context,
-					state: annotatedInnerState
-				} : context;
-				return parser.parse(innerContext);
-			});
-			if (result instanceof Promise) return result.then(processResult);
-			return Promise.resolve(processResult(result));
-		},
-		complete: (state, exec) => {
-			if (isPromptBindState(state) && state.hasCliValue) {
-				const r = withAnnotatedInnerState(state, state.cliState, (annotatedInnerState) => parser.complete(annotatedInnerState, exec));
-				if (r instanceof Promise) return r;
-				return Promise.resolve(r);
-			}
-			const isProbe = exec != null && exec.phase !== "complete";
-			const annotations = (0, __optique_core_annotations.getAnnotations)(state);
-			const innerInitialState = parser.initialState;
-			const shouldInheritInitialStateAnnotations = annotations != null && (innerInitialState == null || typeof innerInitialState === "object");
-			const effectiveInitialState = shouldInheritInitialStateAnnotations ? (0, __optique_core_extension.inheritAnnotations)(state, innerInitialState) : innerInitialState;
-			const readPlaceholder = () => {
-				try {
-					return "placeholder" in parser ? parser.placeholder : void 0;
-				} catch {
-					return void 0;
-				}
+			case "editor": return {
+				success: true,
+				value: await prompts.editor({
+					message: cfg.message,
+					...cfg.default !== void 0 ? { default: cfg.default } : {},
+					...cfg.validate !== void 0 ? { validate: cfg.validate } : {}
+				})
 			};
-			const finalizePrompt = () => {
-				const shouldDefer = withAnnotatedInnerState(state, effectiveInitialState, (annotatedInnerState) => shouldDeferPrompt(parser, annotatedInnerState, exec));
-				if (shouldDefer) return Promise.resolve(deferredPromptResult(readPlaceholder()));
-				if (isProbe) return Promise.resolve({
-					success: true,
-					value: readPlaceholder()
-				});
-				return executePrompt();
+			case "select": return {
+				success: true,
+				value: await prompts.select({
+					message: cfg.message,
+					choices: normalizeChoices(cfg.choices),
+					...cfg.default !== void 0 ? { default: cfg.default } : {}
+				})
 			};
-			const hasDeferHook = typeof parser.shouldDeferCompletion === "function";
-			const decideFromParse = (parseResult) => {
-				const consumed = parseResult.success ? parseResult.consumed.length : 0;
-				const cliState = parseResult.success && consumed === 0 ? parseResult.next.state : void 0;
-				const cliStateIsInjected = cliState != null && typeof cliState === "object" && (0, __optique_core_extension.unwrapInjectedAnnotationState)(cliState) !== cliState;
-				const isSourceBinding = shouldCompleteFromSourceBinding(cliState, state);
-				if (!isSourceBinding) return finalizePrompt();
-				const completeState = parseResult.success ? parseResult.next.state : effectiveInitialState;
-				const innerR = parser.complete(completeState, exec);
-				const handleCompleteResult = (res) => {
-					if (res.success && res.value === void 0 && cliStateIsInjected) return finalizePrompt();
-					if (!res.success) return finalizePrompt();
-					return Promise.resolve(res);
-				};
-				if (innerR instanceof Promise) return innerR.then(handleCompleteResult);
-				return handleCompleteResult(innerR);
+			case "rawlist": return {
+				success: true,
+				value: await prompts.rawlist({
+					message: cfg.message,
+					choices: normalizeChoices(cfg.choices),
+					...cfg.default !== void 0 ? { default: cfg.default } : {}
+				})
+			};
+			case "expand": return {
+				success: true,
+				value: await prompts.expand({
+					message: cfg.message,
+					choices: cfg.choices,
+					...cfg.default !== void 0 ? { default: cfg.default } : {}
+				})
+			};
+			case "checkbox": return {
+				success: true,
+				value: await prompts.checkbox({
+					message: cfg.message,
+					choices: normalizeChoices(cfg.choices)
+				})
 			};
-			if (hasDeferHook) {
-				const innerR = withAnnotatedInnerState(state, effectiveInitialState, (annotatedInnerState) => parser.complete(annotatedInnerState, exec));
-				const handleDeferHookResult = (res) => {
-					if (res.success && res.value === void 0) return finalizePrompt();
-					if (!res.success) return finalizePrompt();
-					return Promise.resolve(res);
-				};
-				if (innerR instanceof Promise) return innerR.then(handleDeferHookResult);
-				return handleDeferHookResult(innerR);
-			}
-			const simParseR = withAnnotatedInnerState(state, effectiveInitialState, (annotatedState) => parser.parse({
-				buffer: [],
-				state: annotatedState,
-				optionsTerminated: false,
-				usage: parser.usage
-			}));
-			if (simParseR instanceof Promise) return simParseR.then(decideFromParse);
-			return decideFromParse(simParseR);
-		},
-		suggest: (context, prefix) => {
-			const innerState = isPromptBindState(context.state) ? context.state.cliState === void 0 ? parser.initialState : context.state.cliState : context.state;
-			const innerContext = innerState !== context.state ? {
-				...context,
-				state: innerState
-			} : context;
-			const innerResult = parser.suggest(innerContext, prefix);
-			return async function* () {
-				yield* innerResult;
-			}();
-		},
-		getDocFragments(state, upperDefaultValue) {
-			const configDefault = "default" in cfg ? cfg.default : void 0;
-			const defaultValue = upperDefaultValue ?? configDefault;
-			return parser.getDocFragments(state, defaultValue);
-		}
-	};
-	(0, __optique_core_extension.defineTraits)(promptedParser, { inheritsAnnotations: true });
-	if ("placeholder" in parser) Object.defineProperty(promptedParser, "placeholder", {
-		get() {
-			try {
-				return parser.placeholder;
-			} catch {
-				return void 0;
-			}
-		},
-		configurable: true,
-		enumerable: false
-	});
-	if (typeof parser.normalizeValue === "function") Object.defineProperty(promptedParser, "normalizeValue", {
-		value: parser.normalizeValue.bind(parser),
-		configurable: true,
-		enumerable: false
-	});
-	const dependencyMetadata = (0, __optique_core_extension.mapSourceMetadata)(parser, (source) => ({
-		...source,
-		extractSourceValue: (state) => {
-			if (!isPromptBindState(state)) return source.extractSourceValue(state);
-			return source.extractSourceValue(state.cliState ?? state);
 		}
-	}));
-	if (dependencyMetadata != null) Object.defineProperty(promptedParser, "dependencyMetadata", {
-		value: dependencyMetadata,
-		configurable: true,
-		enumerable: false
-	});
-	return (0, __optique_core_fluent.fluent)(promptedParser);
+	} catch (error) {
+		if (isExitPromptError(error)) return {
+			success: false,
+			error: __optique_core_message.message`Prompt cancelled.`
+		};
+		throw error;
+	}
 }
 /** Normalize choices to the format Inquirer.js expects. */
 function normalizeChoices(choices) {
@@ -485,7 +223,8 @@ function normalizeChoices(choices) {
 			...c.name !== void 0 ? { name: c.name } : {},
 			..."description" in c && c.description !== void 0 ? { description: c.description } : {},
 			..."short" in c && c.short !== void 0 ? { short: c.short } : {},
-			..."disabled" in c && c.disabled !== void 0 ? { disabled: c.disabled } : {}
+			..."disabled" in c && c.disabled !== void 0 ? { disabled: c.disabled } : {},
+			..."checked" in c && c.checked !== void 0 ? { checked: c.checked } : {}
 		};
 	});
 }