@fadhelhaidar/pi-ask-user 1.0.4 → 1.1.0

package/dist/events.d.ts

@@ -21,6 +21,11 @@
 export declare const ASK_USER_PROMPT_EVENT: "rpiv:ask-user:prompt";
 export interface AskUserPromptEventPayload {
     questions: ReadonlyArray<AskUserPromptQuestion>;
+    /**
+     * The tool call's id — always set. Names this questionnaire on
+     * `ASK_USER_BLOCKED_EVENT` and `ASK_USER_ANSWER_EVENT`.
+     */
+    toolCallId?: string;
 }
 /**
  * Emitted while the questionnaire is awaiting user input (TUI `ui.custom` and
@@ -31,6 +36,11 @@ export declare const ASK_USER_BLOCKED_EVENT: "rpiv:ask-user:blocked";
 export interface AskUserBlockedEventPayload {
     /** True while input is awaited; false when the wait ends (answer, cancel, or error). */
     active: boolean;
+    /**
+     * The tool call's id — always set. Several questionnaires can be open at once,
+     * so pair `active: false` with the prompt it closes by this id.
+     */
+    toolCallId?: string;
 }
 export interface AskUserPromptQuestion {
     /**
@@ -51,3 +61,71 @@ export interface AskUserPromptOption {
     /** True iff the option carries rich preview content (content not shipped). */
     hasPreview: boolean;
 }
+/**
+ * INBOUND — the only event in this contract the package listens for rather than
+ * emits. Answers (or cancels) one open questionnaire without the TUI keystroke
+ * path, so a program driving Pi from outside — a pane supervisor, a phone or web
+ * bridge, a test harness — need not synthesize keys against a rendered dialog.
+ *
+ * `toolCallId` names the questionnaire: the id carried by its
+ * `ASK_USER_PROMPT_EVENT`. It is accepted from the moment that prompt is emitted
+ * (before the dialog is on screen) until the questionnaire closes; the first
+ * answer wins, whether typed in the terminal or sent here.
+ *
+ * Validation is strict and all-or-nothing: every question answered, every index
+ * in range, nothing duplicated — or nothing is applied and the dialog stays open.
+ * A partially applied answer would reach the model indistinguishable from one
+ * the user gave. Unknown fields are ignored (policy rule 2).
+ *
+ * Every attempt gets one verdict on `ASK_USER_ANSWER_RESULT_EVENT`; this payload
+ * carries no callback because payloads must survive JSON serialization.
+ */
+export declare const ASK_USER_ANSWER_EVENT: "rpiv:ask-user:answer";
+export interface AskUserAnswerEventPayload {
+    /** The questionnaire to answer — `toolCallId` from its prompt event. */
+    toolCallId: string;
+    /** Echoed back on the verdict so an emitter can pair it with this request. */
+    requestId?: string;
+    /** One entry per question. Omitted (or empty) only with `cancel`. */
+    answers?: ReadonlyArray<AskUserAnswerEntry>;
+    /** Note for the whole questionnaire — what `n` on the Submit tab attaches in the TUI. */
+    globalNote?: string;
+    /** Decline the questionnaire, as Esc does: the model is told the user declined. */
+    cancel?: boolean;
+}
+/**
+ * One question's answer. Single-select takes exactly one of `optionIndexes`
+ * (one index) or `text`; multi-select takes either or both, like the TUI's
+ * checked options plus its `Type something.` row.
+ */
+export interface AskUserAnswerEntry {
+    /** 0-based index into the prompt's `questions`. */
+    questionIndex: number;
+    /** 0-based, distinct indices into the question's `options`. */
+    optionIndexes?: readonly number[];
+    /** Custom answer — what the `Type something.` row produces. Must not be blank. */
+    text?: string;
+    /** Note on this question — what the `n` key attaches in the TUI. */
+    notes?: string;
+}
+/** Verdict for an `ASK_USER_ANSWER_EVENT`. One per attempt, accepted or not. */
+export declare const ASK_USER_ANSWER_RESULT_EVENT: "rpiv:ask-user:answer-result";
+/**
+ * Why an answer was refused — branch on this, not on `reason`:
+ * - `not_found`: no open questionnaire has that `toolCallId` (never opened, or already closed).
+ * - `invalid_payload`: a field is missing or has the wrong type.
+ * - `invalid_answer`: well-formed, but does not fit the questions (missing, duplicated, out of range).
+ * - `unsupported_host`: the questionnaire runs in an RPC host's own dialogs, which cannot be answered here.
+ */
+export type AskUserAnswerRejectCode = "not_found" | "invalid_payload" | "invalid_answer" | "unsupported_host";
+export interface AskUserAnswerResultEventPayload {
+    ok: boolean;
+    /** Set when `ok` is false. */
+    code?: AskUserAnswerRejectCode;
+    /** Human-readable detail for logs. Wording may change — do not parse it. */
+    reason?: string;
+    /** Echoed from the request when it was a string. */
+    requestId?: string;
+    /** Echoed from the request when it was a string. */
+    toolCallId?: string;
+}

package/dist/events.js

@@ -1,8 +1,12 @@
 import {
   ASK_USER_PROMPT_EVENT2,
-  ASK_USER_BLOCKED_EVENT2
-} from "./chunks/index-bx2tbz93.js";
+  ASK_USER_BLOCKED_EVENT2,
+  ASK_USER_ANSWER_EVENT2,
+  ASK_USER_ANSWER_RESULT_EVENT2
+} from "./chunks/index-pen3t92h.js";
 export {
+  ASK_USER_ANSWER_EVENT2 as ASK_USER_ANSWER_EVENT,
+  ASK_USER_ANSWER_RESULT_EVENT2 as ASK_USER_ANSWER_RESULT_EVENT,
   ASK_USER_BLOCKED_EVENT2 as ASK_USER_BLOCKED_EVENT,
   ASK_USER_PROMPT_EVENT2 as ASK_USER_PROMPT_EVENT
 };

package/dist/index.d.ts

@@ -1,8 +1,14 @@
 import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
 
 export {
+	ASK_USER_ANSWER_EVENT,
+	ASK_USER_ANSWER_RESULT_EVENT,
 	ASK_USER_BLOCKED_EVENT,
 	ASK_USER_PROMPT_EVENT,
+	type AskUserAnswerEntry,
+	type AskUserAnswerEventPayload,
+	type AskUserAnswerRejectCode,
+	type AskUserAnswerResultEventPayload,
 	type AskUserBlockedEventPayload,
 	type AskUserPromptEventPayload,
 	type AskUserPromptOption,