@henryqw/pi-ask-question 0.1.11 → 0.2.0

package/README.md

@@ -31,3 +31,5 @@ pi install npm:@henryqw/pi-ask-question
 ```
 
 Supply one to three options in preference order. UI marks the first `(Recommended)` and adds `Something else.`, which opens a text input for a custom answer. Empty questions, blank or duplicate labels, empty lists, more than three options, and non-interactive sessions return an error. Aborting the tool closes the pending question.
+
+Extensions can reuse the same validated interaction with the `askQuestion(params, ctx, signal)` package export; it returns the tool's answer details without registering another UI flow.

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import type { ExtensionContext } from "@earendil-works/pi-coding-agent";
+export interface AskQuestionOption {
+    label: string;
+    description?: string;
+}
+export interface AskQuestionRequest {
+    question: string;
+    options: AskQuestionOption[];
+}
+export interface AskQuestionResult {
+    question: string;
+    options: string[];
+    answer: string | null;
+    wasCustom?: boolean;
+    selectedIndex?: number;
+    error?: string;
+}
+type AskQuestionContext = Pick<ExtensionContext, "mode" | "ui">;
+/** Run the validated interactive question flow shared by consumers. */
+export declare function askQuestion(params: AskQuestionRequest, ctx: AskQuestionContext, signal?: AbortSignal): Promise<AskQuestionResult>;
+export {};

package/dist/index.js

@@ -0,0 +1,49 @@
+const CUSTOM_OPTION_LABEL = "Something else.";
+const RECOMMENDED_SUFFIX = /\s*\(recommended\)\s*$/i;
+const withRecommended = (label) => `${label.replace(RECOMMENDED_SUFFIX, "")} (Recommended)`;
+/** Run the validated interactive question flow shared by consumers. */
+export async function askQuestion(params, ctx, signal) {
+    const question = params.question.trim();
+    const suppliedOptions = params.options.map((option) => ({
+        label: option.label.trim(),
+        ...(option.description === undefined ? {} : { description: option.description.trim() }),
+    }));
+    const options = suppliedOptions.map((option) => option.label);
+    if (ctx.mode !== "tui") {
+        const error = "UI not available (running in non-interactive mode)";
+        return { question, options, answer: null, error };
+    }
+    let validationError;
+    if (!question)
+        validationError = "Question must not be blank";
+    else if (suppliedOptions.length < 1 || suppliedOptions.length > 3)
+        validationError = "Provide one to three options";
+    else if (suppliedOptions.some((option) => !option.label))
+        validationError = "Option labels must not be blank";
+    else if (new Set(options.map((option) => option.toLowerCase())).size !== options.length)
+        validationError = "Option labels must be unique";
+    else if (options.some((option) => option.toLowerCase() === CUSTOM_OPTION_LABEL.toLowerCase()))
+        validationError = `Option label "${CUSTOM_OPTION_LABEL}" is reserved`;
+    if (validationError)
+        return { question, options, answer: null, error: validationError };
+    const choices = suppliedOptions.map((option, index) => {
+        const label = index === 0 ? withRecommended(option.label) : option.label;
+        return `${index + 1}. ${label}${option.description ? ` — ${option.description}` : ""}`;
+    });
+    choices.push(`${choices.length + 1}. ${CUSTOM_OPTION_LABEL}`);
+    const selected = await ctx.ui.select(question, choices, { signal });
+    const selectedIndex = selected === undefined ? -1 : choices.indexOf(selected);
+    const wasCustom = selectedIndex === suppliedOptions.length;
+    const answer = wasCustom
+        ? (await ctx.ui.input(CUSTOM_OPTION_LABEL, "Type your answer", { signal }))?.trim()
+        : suppliedOptions[selectedIndex]?.label;
+    if (!answer)
+        return { question, options, answer: null };
+    return {
+        question,
+        options,
+        answer,
+        wasCustom,
+        selectedIndex: wasCustom ? undefined : selectedIndex + 1,
+    };
+}

package/extensions/ask-question.ts

@@ -1,20 +1,7 @@
 import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
+import { askQuestion } from "@henryqw/pi-ask-question";
 import { Type } from "typebox";
 
-const CUSTOM_OPTION_LABEL = "Something else.";
-// Models are told to omit "(Recommended)" from labels but don't always comply; normalize instead of duplicating.
-const RECOMMENDED_SUFFIX = /\s*\(recommended\)\s*$/i;
-const withRecommended = (label: string): string => `${label.replace(RECOMMENDED_SUFFIX, "")} (Recommended)`;
-
-interface QuestionDetails {
-	question: string;
-	options: string[];
-	answer: string | null;
-	wasCustom?: boolean;
-	selectedIndex?: number;
-	error?: string;
-}
-
 const QuestionOptionSchema = Type.Object({
 	label: Type.String({ description: "Display label for the option", minLength: 1 }),
 	description: Type.Optional(Type.String({ description: "Optional description shown below label", minLength: 1 })),
@@ -44,62 +31,19 @@ export default function askQuestionExtension(pi: ExtensionAPI): void {
 		executionMode: "sequential",
 
 		async execute(_toolCallId, params, signal, _onUpdate, ctx) {
-			const question = params.question.trim();
-			const suppliedOptions = params.options.map((option) => ({
-				label: option.label.trim(),
-				...(option.description === undefined ? {} : { description: option.description.trim() }),
-			}));
-			const options = suppliedOptions.map((option) => option.label);
-			if (ctx.mode !== "tui") {
-				const error = "UI not available (running in non-interactive mode)";
-				return {
-					content: [{ type: "text" as const, text: `Error: ${error}` }],
-					details: { question, options, answer: null, error } satisfies QuestionDetails,
-				};
-			}
-			let validationError: string | undefined;
-			if (!question) validationError = "Question must not be blank";
-			else if (suppliedOptions.some((option) => !option.label)) validationError = "Option labels must not be blank";
-			else if (new Set(options.map((option) => option.toLowerCase())).size !== options.length) validationError = "Option labels must be unique";
-			else if (options.some((option) => option.toLowerCase() === CUSTOM_OPTION_LABEL.toLowerCase())) validationError = `Option label "${CUSTOM_OPTION_LABEL}" is reserved`;
-			if (validationError) {
-				return {
-					content: [{ type: "text" as const, text: `Error: ${validationError}` }],
-					details: { question, options, answer: null, error: validationError } satisfies QuestionDetails,
-				};
-			}
-
-			const choices = suppliedOptions.map((option, index) => {
-				const label = index === 0 ? withRecommended(option.label) : option.label;
-				return `${index + 1}. ${label}${option.description ? ` — ${option.description}` : ""}`;
-			});
-			choices.push(`${choices.length + 1}. ${CUSTOM_OPTION_LABEL}`);
-
-			const selected = await ctx.ui.select(question, choices, { signal });
-			const selectedIndex = selected === undefined ? -1 : choices.indexOf(selected);
-			const wasCustom = selectedIndex === suppliedOptions.length;
-			const answer = wasCustom
-				? (await ctx.ui.input(CUSTOM_OPTION_LABEL, "Type your answer", { signal }))?.trim()
-				: suppliedOptions[selectedIndex]?.label;
-
-			if (!answer) {
-				return {
-					content: [{ type: "text" as const, text: "User cancelled question" }],
-					details: { question, options, answer: null } satisfies QuestionDetails,
-				};
-			}
+			const details = await askQuestion(params, ctx, signal);
 			return {
 				content: [{
 					type: "text" as const,
-					text: wasCustom ? `User wrote: ${answer}` : `User selected: ${selectedIndex + 1}. ${answer}`,
+					text: details.error
+						? `Error: ${details.error}`
+						: !details.answer
+							? "User cancelled question"
+							: details.wasCustom
+								? `User wrote: ${details.answer}`
+								: `User selected: ${details.selectedIndex}. ${details.answer}`,
 				}],
-				details: {
-					question,
-					options,
-					answer,
-					wasCustom,
-					selectedIndex: wasCustom ? undefined : selectedIndex + 1,
-				} satisfies QuestionDetails,
+				details,
 			};
 		},
 	});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@henryqw/pi-ask-question",
-  "version": "0.1.11",
+  "version": "0.2.0",
   "description": "Ask Pi users one interactive question with choices or a custom answer.",
   "keywords": [
     "pi-package",
@@ -14,14 +14,24 @@
   },
   "license": "MIT",
   "files": [
+    "dist",
     "extensions",
     "README.md",
     "LICENSE"
   ],
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
   "scripts": {
-    "test": "node --test test/*.test.ts",
+    "build": "tsc --project tsconfig.build.json",
+    "test": "npm run build && node --test test/*.test.ts",
     "test:manual": "pi --no-extensions -e ./extensions/ask-question.ts --tools ask_question --no-session \"We need storage for a small team app. Before making changes, ask me to choose storage.\"",
-    "typecheck": "tsc --noEmit --allowImportingTsExtensions --target ES2022 --module NodeNext --moduleResolution NodeNext --skipLibCheck extensions/ask-question.ts test/*.test.ts",
+    "typecheck": "tsc --noEmit --allowImportingTsExtensions --target ES2022 --module NodeNext --moduleResolution NodeNext --skipLibCheck src/*.ts extensions/ask-question.ts test/*.test.ts",
+    "prepack": "npm run build",
     "pack:check": "npm pack --dry-run"
   },
   "peerDependencies": {