@geoqiao/pi-ask 1.1.0

package/src/constants/text.ts

@@ -0,0 +1,12 @@
+export const OTHER_OPTION_VALUE = "__other__";
+export const OTHER_OPTION_LABEL = "Type your own";
+export const SUBMIT_CHOICES = ["Submit", "Elaborate", "Cancel"] as const;
+export const NO_PREVIEW_TEXT = "No preview available";
+export const ELABORATION_INSTRUCTION =
+	"First answer the user's noted clarification directly and concisely using the provided question and option context. Do not treat these notes as final answers. Then re-ask only the affected questions if a choice is still needed afterward. Do not jump straight to a follow-up question unless the note is already resolved.";
+export const CANCELLED_SUMMARY = "User cancelled the ask flow";
+export const SUBMITTED_SUMMARY = "User submitted the ask flow";
+export const ELABORATED_SUMMARY = "User asked for elaboration based on notes";
+export const CANCELLED_RESULT_TEXT = "Cancelled";
+export const SUBMITTED_RESULT_TEXT = "Submitted";
+export const ELABORATED_RESULT_TEXT = "Elaboration requested";

package/src/constants/ui.ts

@@ -0,0 +1,22 @@
+export const UI_DIMENSIONS = {
+	boxMinWidth: 10,
+	callLabelTruncateWidth: 50,
+	editorContentPadding: 5,
+	editorIndentedPadding: 7,
+	editorMinWidth: 8,
+	previewWideMinWidth: 90,
+	previewMinRightWidth: 24,
+	previewLeftMinWidth: 22,
+	previewLeftMaxWidth: 34,
+	previewLeftRatio: 0.34,
+	submitWideMinWidth: 64,
+	submitMinReviewWidth: 24,
+} as const;
+
+export const UI_TEXT = {
+	questionNoteTitle: "Note:",
+	reviewTitle: "Review answers",
+	unanswered: "→ unanswered",
+	editorPlaceholderInput: "Type answer...",
+	editorPlaceholderNote: "Add a note...",
+} as const;

package/src/index.ts

@@ -0,0 +1,30 @@
+import { dirname, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
+import { registerAnswerCommands } from "./answer-commands.ts";
+import { registerAskSettingsCommand } from "./ask-settings-command.ts";
+import { registerAskTool } from "./ask-tool.ts";
+import { resetAskConfigStore } from "./config/store.ts";
+import { createRemoteAskRuntime } from "./remote-ask.ts";
+
+const PACKAGE_ROOT = resolve(dirname(fileURLToPath(import.meta.url)), "..");
+const CONFIGURATION_DOC_PATH = resolve(
+	PACKAGE_ROOT,
+	"docs",
+	"configuration.md"
+);
+const PI_ASK_CONFIG_PROMPT = `When the user asks to configure, customize, debug, or explain @eko24ive/pi-ask settings or keymaps, first read ${CONFIGURATION_DOC_PATH} and follow it as the source of truth before editing config files.`;
+
+export default function askExtension(pi: ExtensionAPI) {
+	resetAskConfigStore();
+	pi.on("before_agent_start", async (event) => ({
+		systemPrompt: `${event.systemPrompt}\n\n${PI_ASK_CONFIG_PROMPT}`,
+	}));
+	const remoteAsk = createRemoteAskRuntime(pi.events);
+	pi.on("session_shutdown", () => {
+		remoteAsk.disposeAll();
+	});
+	registerAskTool(pi, remoteAsk);
+	registerAskSettingsCommand(pi);
+	registerAnswerCommands(pi, remoteAsk);
+}

package/src/math.ts

@@ -0,0 +1,3 @@
+export function clamp(value: number, min: number, max: number): number {
+	return Math.min(max, Math.max(min, value));
+}

package/src/notifications.ts

@@ -0,0 +1,119 @@
+import { exec } from "node:child_process";
+import { promisify } from "node:util";
+import type { AskConfig } from "./config/schema.ts";
+import type { AskQuestion } from "./types.ts";
+
+const execAsync = promisify(exec);
+const DEFAULT_TITLE = "pi ask";
+const EVENT = "question.waiting";
+const MAX_MESSAGE_LENGTH = 120;
+const COMMAND_TIMEOUT_MS = 5000;
+
+export interface AskNotificationPayload {
+	event: typeof EVENT;
+	message: string;
+	title: string;
+}
+
+export type NotificationAttemptStatus = "attempted" | "failed" | "skipped";
+
+export interface NotificationAttempt {
+	channel: string;
+	error?: string;
+	status: NotificationAttemptStatus;
+}
+
+export function createQuestionWaitingNotification(
+	question: Pick<AskQuestion, "label" | "prompt">
+): AskNotificationPayload {
+	const subject = question.label || question.prompt;
+	return {
+		event: EVENT,
+		title: DEFAULT_TITLE,
+		message: truncate(
+			`Question waiting: ${singleLine(subject)}`,
+			MAX_MESSAGE_LENGTH
+		),
+	};
+}
+
+export async function notifyQuestionWaiting(
+	config: AskConfig,
+	payload: AskNotificationPayload
+): Promise<NotificationAttempt[]> {
+	if (!config.notifications.enabled) {
+		return [{ channel: "notifications", status: "skipped" }];
+	}
+	const attempts: NotificationAttempt[] = [];
+	for (const channel of config.notifications.channels) {
+		attempts.push(await notifyChannel(channel, payload));
+	}
+	return attempts;
+}
+
+async function notifyChannel(
+	channel: AskConfig["notifications"]["channels"][number],
+	payload: AskNotificationPayload
+): Promise<NotificationAttempt> {
+	const type = typeof channel === "string" ? channel : channel.type;
+	try {
+		switch (type) {
+			case "bell":
+				process.stdout.write("\x07");
+				return { channel: type, status: "attempted" };
+			case "osc9":
+				process.stdout.write(`\x1b]9;${sanitizeOsc(payload.message)}\x07`);
+				return { channel: type, status: "attempted" };
+			case "osc777":
+				process.stdout.write(
+					`\x1b]777;notify;${sanitizeOscField(payload.title)};${sanitizeOscField(payload.message)}\x07`
+				);
+				return { channel: type, status: "attempted" };
+			case "command": {
+				if (typeof channel === "string") {
+					return { channel: type, status: "failed", error: "Missing command" };
+				}
+				const env = { ...process.env };
+				env.ASK_NOTIFY_EVENT = payload.event;
+				env.ASK_NOTIFY_MESSAGE = payload.message;
+				env.ASK_NOTIFY_TITLE = payload.title;
+				await execAsync(channel.command, {
+					env,
+					timeout: COMMAND_TIMEOUT_MS,
+				});
+				return { channel: type, status: "attempted" };
+			}
+			default:
+				return { channel: String(type), status: "skipped" };
+		}
+	} catch (error) {
+		return {
+			channel: type,
+			error: error instanceof Error ? error.message : String(error),
+			status: "failed",
+		};
+	}
+}
+
+function singleLine(value: string): string {
+	return value.replace(/\s+/gu, " ").trim();
+}
+
+function truncate(value: string, maxLength: number): string {
+	return value.length <= maxLength
+		? value
+		: `${value.slice(0, maxLength - 1)}…`;
+}
+
+function sanitizeOsc(value: string): string {
+	return [...singleLine(value)]
+		.filter((character) => {
+			const code = character.codePointAt(0) ?? 0;
+			return code > 31 && code !== 127;
+		})
+		.join("");
+}
+
+function sanitizeOscField(value: string): string {
+	return sanitizeOsc(value).replaceAll(";", ":");
+}