@optique/clack 1.2.0-dev.2196 → 1.2.0-dev.2200

package/dist/index.cjs

@@ -0,0 +1,195 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+const __clack_prompts = __toESM(require("@clack/prompts"));
+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/clack/prompt-functions");
+const defaultPromptFunctions = {
+	text: __clack_prompts.text,
+	password: __clack_prompts.password,
+	confirm: __clack_prompts.confirm,
+	select: __clack_prompts.select,
+	multiselect: __clack_prompts.multiselect,
+	isCancel: __clack_prompts.isCancel
+};
+function promptFunctionKeys() {
+	return Object.keys(defaultPromptFunctions);
+}
+function assignPromptFunctionOverride(override, key, candidate) {
+	if (typeof candidate === "function") override[key] = candidate;
+}
+function getPromptFunctionsOverride(value) {
+	if (typeof value !== "object" || value == null) return void 0;
+	const override = {};
+	for (const key of promptFunctionKeys()) assignPromptFunctionOverride(override, key, Reflect.get(value, key));
+	return override;
+}
+function getPromptFunctions() {
+	const override = getPromptFunctionsOverride(Reflect.get(globalThis, promptFunctionsOverrideSymbol));
+	return override != null ? {
+		...defaultPromptFunctions,
+		...override
+	} : defaultPromptFunctions;
+}
+/**
+* Wraps a parser with an interactive Clack prompt fallback.
+*
+* @param parser Inner parser that reads CLI values.
+* @param config Type-safe Clack 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.
+* @since 1.2.0
+*/
+function prompt(parser, config) {
+	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" && "initialValue" in config) return config.initialValue;
+	return void 0;
+}
+async function executePromptRaw(config) {
+	const cfg = config;
+	const type = cfg.type;
+	if (!isPromptType(type)) throw new TypeError(`Unsupported prompt type: ${String(type)}.`);
+	const prompts = getPromptFunctions();
+	if ("prompter" in cfg && cfg.prompter != null) {
+		const value = await cfg.prompter();
+		if (prompts.isCancel(value)) return {
+			success: false,
+			error: __optique_core_message.message`Prompt cancelled.`
+		};
+		if (cfg.type === "number") return normalizeNumberResult(value);
+		if (cfg.type === "multiselect") return normalizeMultiselectResult(value, cfg);
+		return {
+			success: true,
+			value
+		};
+	}
+	const result = await executeClackPrompt(cfg, prompts);
+	if (prompts.isCancel(result)) return {
+		success: false,
+		error: __optique_core_message.message`Prompt cancelled.`
+	};
+	if (cfg.type === "number") return normalizeNumberResult(result);
+	if (cfg.type === "multiselect") return normalizeMultiselectResult(result, cfg);
+	return {
+		success: true,
+		value: result
+	};
+}
+function isPromptType(value) {
+	return value === "text" || value === "password" || value === "confirm" || value === "number" || value === "select" || value === "multiselect";
+}
+function executeClackPrompt(cfg, prompts) {
+	switch (cfg.type) {
+		case "text": return prompts.text({
+			message: cfg.message,
+			...cfg.placeholder !== void 0 ? { placeholder: cfg.placeholder } : {},
+			...cfg.initialValue !== void 0 ? { initialValue: cfg.initialValue } : {},
+			...cfg.validate !== void 0 ? { validate: cfg.validate } : {}
+		});
+		case "password": return prompts.password({
+			message: cfg.message,
+			...cfg.mask !== void 0 ? { mask: cfg.mask } : {},
+			...cfg.validate !== void 0 ? { validate: cfg.validate } : {}
+		});
+		case "confirm": return prompts.confirm({
+			message: cfg.message,
+			...cfg.initialValue !== void 0 ? { initialValue: cfg.initialValue } : {}
+		});
+		case "number": return prompts.text({
+			message: cfg.message,
+			...cfg.placeholder !== void 0 ? { placeholder: cfg.placeholder } : {},
+			...cfg.initialValue !== void 0 ? { initialValue: String(cfg.initialValue) } : {},
+			validate: async (value) => {
+				const parsed = parseNumberPromptValue(value);
+				if (parsed == null) return "Enter a number.";
+				if (cfg.min !== void 0 && parsed < cfg.min) return `Must be at least ${cfg.min}.`;
+				if (cfg.max !== void 0 && parsed > cfg.max) return `Must be at most ${cfg.max}.`;
+				return await cfg.validate?.(parsed);
+			}
+		});
+		case "select": return prompts.select({
+			message: cfg.message,
+			options: normalizeOptions(cfg.options),
+			...cfg.initialValue !== void 0 ? { initialValue: cfg.initialValue } : {}
+		});
+		case "multiselect": return prompts.multiselect({
+			message: cfg.message,
+			options: normalizeOptions(cfg.options),
+			...cfg.required !== void 0 ? { required: cfg.required } : {}
+		});
+	}
+}
+function normalizeNumberResult(result) {
+	const parsed = typeof result === "number" && Number.isFinite(result) ? result : typeof result === "string" ? parseNumberPromptValue(result) : null;
+	if (parsed == null) return {
+		success: false,
+		error: __optique_core_message.message`No number provided.`
+	};
+	return {
+		success: true,
+		value: parsed
+	};
+}
+function normalizeMultiselectResult(result, config) {
+	const values = Array.isArray(result) ? result : [];
+	if (config.required === true && values.length < 1) return {
+		success: false,
+		error: __optique_core_message.message`No option selected.`
+	};
+	return {
+		success: true,
+		value: values
+	};
+}
+function parseNumberPromptValue(value) {
+	if (value.trim() === "") return null;
+	const parsed = Number(value);
+	return Number.isFinite(parsed) ? parsed : null;
+}
+function normalizeOptions(options) {
+	return options.map((option) => {
+		if (typeof option === "string") return {
+			value: option,
+			label: option
+		};
+		return {
+			value: option.value,
+			...option.label !== void 0 ? { label: option.label } : {},
+			...option.hint !== void 0 ? { hint: option.hint } : {},
+			...option.disabled !== void 0 ? { disabled: option.disabled } : {}
+		};
+	});
+}
+
+//#endregion
+exports.prompt = prompt;

package/dist/index.d.cts

@@ -0,0 +1,159 @@
+import { FluentParser } from "@optique/core/fluent";
+import { Mode, Parser } from "@optique/core/parser";
+
+//#region src/index.d.ts
+
+/**
+ * A choice item for `select` and `multiselect` prompts.
+ *
+ * @since 1.2.0
+ */
+interface Option {
+  /**
+   * The value returned when this option is selected.
+   */
+  readonly value: string;
+  /**
+   * Display label shown in the prompt. Defaults to `value`.
+   */
+  readonly label?: string;
+  /**
+   * Additional hint shown next to the option.
+   */
+  readonly hint?: string;
+  /**
+   * If truthy, the option cannot be selected.
+   */
+  readonly disabled?: boolean | string;
+}
+/**
+ * Configuration for a `text` prompt.
+ *
+ * @since 1.2.0
+ */
+interface TextConfig {
+  readonly type: "text";
+  /** The question to display to the user. */
+  readonly message: string;
+  /** Placeholder text shown before input. */
+  readonly placeholder?: string;
+  /** Initial value pre-filled in the prompt. */
+  readonly initialValue?: string;
+  /** Validation function called when the user submits. */
+  readonly validate?: (value: string) => string | void | Promise<string | void>;
+  /** Override the prompt execution. Useful for testing. */
+  readonly prompter?: () => Promise<string>;
+}
+/**
+ * Configuration for a `password` prompt.
+ *
+ * @since 1.2.0
+ */
+interface PasswordConfig {
+  readonly type: "password";
+  /** The question to display to the user. */
+  readonly message: string;
+  /** Mask character shown while typing. */
+  readonly mask?: string;
+  /** Validation function called when the user submits. */
+  readonly validate?: (value: string) => string | void | Promise<string | void>;
+  /** Override the prompt execution. Useful for testing. */
+  readonly prompter?: () => Promise<string>;
+}
+/**
+ * Configuration for a `confirm` prompt.
+ *
+ * @since 1.2.0
+ */
+interface ConfirmConfig {
+  readonly type: "confirm";
+  /** The question to display to the user. */
+  readonly message: string;
+  /** Initial Boolean value. */
+  readonly initialValue?: boolean;
+  /** Override the prompt execution. Useful for testing. */
+  readonly prompter?: () => Promise<boolean>;
+}
+/**
+ * Configuration for a `number` prompt.
+ *
+ * Clack does not provide a dedicated number prompt, so *@optique/clack* uses a
+ * text prompt and converts the submitted value to a number.
+ *
+ * @since 1.2.0
+ */
+interface NumberPromptConfig {
+  readonly type: "number";
+  /** The question to display to the user. */
+  readonly message: string;
+  /** Placeholder text shown before input. */
+  readonly placeholder?: string;
+  /** Initial numeric value. */
+  readonly initialValue?: number;
+  /** Minimum accepted value. */
+  readonly min?: number;
+  /** Maximum accepted value. */
+  readonly max?: number;
+  /** Additional validation after numeric conversion. */
+  readonly validate?: (value: number) => string | void | Promise<string | void>;
+  /** Override the prompt execution. Useful for testing. */
+  readonly prompter?: () => Promise<number | undefined>;
+}
+/**
+ * Configuration for a `select` prompt.
+ *
+ * @since 1.2.0
+ */
+interface SelectConfig {
+  readonly type: "select";
+  /** The question to display to the user. */
+  readonly message: string;
+  /** Available options. */
+  readonly options: readonly (string | Option)[];
+  /** Initially selected option value. */
+  readonly initialValue?: string;
+  /** Override the prompt execution. Useful for testing. */
+  readonly prompter?: () => Promise<string>;
+}
+/**
+ * Configuration for a `multiselect` prompt.
+ *
+ * @since 1.2.0
+ */
+interface MultiselectConfig {
+  readonly type: "multiselect";
+  /** The question to display to the user. */
+  readonly message: string;
+  /** Available options. */
+  readonly options: readonly (string | Option)[];
+  /** Whether at least one option must be selected. */
+  readonly required?: boolean;
+  /** Override the prompt execution. Useful for testing. */
+  readonly prompter?: () => Promise<readonly string[]>;
+}
+/**
+ * A union of all string-valued prompt configurations.
+ *
+ * @since 1.2.0
+ */
+type StringPromptConfig = TextConfig | PasswordConfig | SelectConfig;
+/**
+ * Type-safe Clack prompt configuration for a given parser value type `T`.
+ *
+ * @since 1.2.0
+ */
+type PromptConfig<T> = BasePromptConfig<Exclude<T, null | undefined>>;
+type BasePromptConfig<T> = T extends boolean ? ConfirmConfig : T extends number ? NumberPromptConfig : T extends string ? StringPromptConfig : T extends readonly string[] ? MultiselectConfig : never;
+/**
+ * Wraps a parser with an interactive Clack prompt fallback.
+ *
+ * @param parser Inner parser that reads CLI values.
+ * @param config Type-safe Clack 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.
+ * @since 1.2.0
+ */
+declare function prompt<M extends Mode, TValue, TState>(parser: Parser<M, TValue, TState>, config: PromptConfig<TValue>): FluentParser<"async", TValue, TState>;
+//#endregion
+export { ConfirmConfig, MultiselectConfig, NumberPromptConfig, Option, PasswordConfig, PromptConfig, SelectConfig, StringPromptConfig, TextConfig, prompt };

package/dist/index.js

@@ -59,6 +59,10 @@ async function executePromptRaw(config) {
 	const prompts = getPromptFunctions();
 	if ("prompter" in cfg && cfg.prompter != null) {
 		const value = await cfg.prompter();
+		if (prompts.isCancel(value)) return {
+			success: false,
+			error: message`Prompt cancelled.`
+		};
 		if (cfg.type === "number") return normalizeNumberResult(value);
 		if (cfg.type === "multiselect") return normalizeMultiselectResult(value, cfg);
 		return {
@@ -134,13 +138,14 @@ function normalizeNumberResult(result) {
 	};
 }
 function normalizeMultiselectResult(result, config) {
-	if (config.required === true && Array.isArray(result) && result.length < 1) return {
+	const values = Array.isArray(result) ? result : [];
+	if (config.required === true && values.length < 1) return {
 		success: false,
 		error: message`No option selected.`
 	};
 	return {
 		success: true,
-		value: result
+		value: values
 	};
 }
 function parseNumberPromptValue(value) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/clack",
-  "version": "1.2.0-dev.2196",
+  "version": "1.2.0-dev.2200",
   "description": "Interactive prompt support for Optique via Clack",
   "keywords": [
     "CLI",
@@ -41,11 +41,16 @@
   ],
   "type": "module",
   "module": "./dist/index.js",
+  "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "types": {
+        "import": "./dist/index.d.ts",
+        "require": "./dist/index.d.cts"
+      },
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
   },
   "imports": {
@@ -57,16 +62,16 @@
   "sideEffects": false,
   "dependencies": {
     "@clack/prompts": "^1.6.0",
-    "@optique/core": "1.2.0-dev.2196+93daad17",
-    "@optique/prompt": "1.2.0-dev.2196+93daad17"
+    "@optique/prompt": "1.2.0-dev.2200+9ff07852",
+    "@optique/core": "1.2.0-dev.2200+9ff07852"
   },
   "devDependencies": {
     "@types/node": "^24.0.0",
     "fast-check": "^4.7.0",
     "tsdown": "^0.13.0",
     "typescript": "^5.8.3",
-    "@optique/env": "1.2.0-dev.2196+93daad17",
-    "@optique/run": "1.2.0-dev.2196+93daad17"
+    "@optique/env": "1.2.0-dev.2200+9ff07852",
+    "@optique/run": "1.2.0-dev.2200+9ff07852"
   },
   "scripts": {
     "build": "tsdown",