@tt-a1i/openpi 0.1.0

package/extensions/ask-user/limits.ts

@@ -0,0 +1,89 @@
+import { sanitizeTerminalText } from "../shared/terminal-text.ts";
+
+export const MAX_ANSWER_DRAFT_UTF8_BYTES = 8_000;
+
+function utf8BytesAtMost(value: string, maximum: number) {
+  let bytes = 0;
+  for (const character of value) {
+    const codePoint = character.codePointAt(0)!;
+    bytes +=
+      codePoint <= 0x7f
+        ? 1
+        : codePoint <= 0x7ff
+          ? 2
+          : codePoint <= 0xffff
+            ? 3
+            : 4;
+    if (bytes > maximum) return undefined;
+  }
+  return bytes;
+}
+
+export function answerDraftByteLength(value: string) {
+  return utf8BytesAtMost(value, Number.POSITIVE_INFINITY)!;
+}
+
+export function answerDraftFits(value: string) {
+  return utf8BytesAtMost(value, MAX_ANSWER_DRAFT_UTF8_BYTES) !== undefined;
+}
+
+export function longerThanAnswerDraftLimit(next: string, previous: string) {
+  return answerDraftByteLength(next) > answerDraftByteLength(previous);
+}
+
+export const BRACKETED_PASTE_START = "\u001b[200~";
+export const BRACKETED_PASTE_END = "\u001b[201~";
+// eslint-disable-next-line no-control-regex
+const INPUT_CONTROL_PATTERN = /[\u0000-\u001f\u007f-\u009f]/;
+
+function textBearingEditorInput(input: string) {
+  if (
+    input.startsWith(BRACKETED_PASTE_START) &&
+    input.endsWith(BRACKETED_PASTE_END)
+  ) {
+    return {
+      bracketed: true,
+      text: input.slice(
+        BRACKETED_PASTE_START.length,
+        -BRACKETED_PASTE_END.length,
+      ),
+    };
+  }
+  // Escape-prefixed values and one-byte controls are editor commands. Other
+  // values are text, including non-bracketed multi-line/IME commits.
+  if (
+    input.startsWith("\u001b") ||
+    (input.length === 1 && INPUT_CONTROL_PATTERN.test(input))
+  ) {
+    return undefined;
+  }
+  return { bracketed: false, text: input };
+}
+
+/** Strip terminal/bidi controls before text-bearing input reaches Editor. */
+export function sanitizeAnswerDraftEditorInput(input: string) {
+  const insertion = textBearingEditorInput(input);
+  if (!insertion) return input;
+  const safe = sanitizeTerminalText(insertion.text);
+  return insertion.bracketed
+    ? `${BRACKETED_PASTE_START}${safe}${BRACKETED_PASTE_END}`
+    : safe;
+}
+
+/**
+ * Reject text-bearing input before Editor stores a bracketed or bulk paste.
+ * Small control-key sequences are left to Editor and checked after handling.
+ */
+export function prospectiveAnswerDraftFits(current: string, input: string) {
+  const insertion = textBearingEditorInput(input);
+  if (!insertion && !answerDraftFits(input)) {
+    // Unknown large control-bearing input must not reach Editor's paste map.
+    return false;
+  }
+  if (!insertion) return true;
+  const remaining =
+    MAX_ANSWER_DRAFT_UTF8_BYTES - answerDraftByteLength(current);
+  return (
+    remaining >= 0 && utf8BytesAtMost(insertion.text, remaining) !== undefined
+  );
+}

package/extensions/ask-user/prompt.ts

@@ -0,0 +1,76 @@
+import { sanitizeTerminalText } from "../shared/terminal-text.ts";
+
+interface AskUserAnswer {
+  readonly id: string;
+  readonly selected?: string;
+  readonly note?: string;
+  readonly custom?: string;
+  readonly rephrase?: true;
+}
+
+function safeSingleLine(value: string) {
+  return sanitizeTerminalText(value).replace(/\s+/g, " ").trim();
+}
+
+/** Model-facing schema descriptions for structured user questions. */
+export const ASK_USER_PARAMETER_DESCRIPTIONS = {
+  id: "Stable snake_case identifier used to map the answer",
+  header: "Short UI header, ideally 12 characters or fewer",
+  optionLabel:
+    'Concise user-facing label. Put the recommended option first and suffix its label with "(Recommended)".',
+  optionDescription:
+    "One short sentence explaining the impact or tradeoff if selected",
+  optionPreview:
+    "Optional concrete artifact shown while this option is highlighted — a short code snippet, config, or ASCII layout the user can compare against the other options. Lines are shown as written (indentation preserved, no re-wrapping), so keep them narrow. Omit unless seeing the artifact genuinely changes the decision; the description already carries the tradeoff.",
+  question: "A single-sentence question shown to the user",
+  options:
+    "Between 2 and 5 mutually exclusive choices. Never include an Other/custom option; the UI adds one automatically.",
+  questions:
+    "One to three independent questions (see the tool guidelines for when to batch more than one).",
+};
+
+export const ASK_USER_TOOL_DESCRIPTION =
+  "Ask the user one to three short, independent multiple-choice questions and wait for explicitly reviewed answers. Each question gets a free-form answer option; submitting it blank requests a clearer or split question. The user may add notes, revise any draft answer from the review screen, or dismiss the request. Prefer one question unless several independent decisions should be answered together.";
+
+export const ASK_USER_PROMPT_SNIPPET =
+  "Ask 1-3 structured user questions with draft answers, final review, optional notes, and free-form answers";
+
+export const ASK_USER_PROMPT_GUIDELINES = [
+  "Use ask_user only for a genuine ambiguity or user preference that cannot be resolved from the code, docs, or conversation and would materially change the result. Never use it to ask whether to continue.",
+  'Before calling ask_user, analyze the choice: provide mutually exclusive options, put your recommendation first, suffix its label with "(Recommended)", and explain each option\'s impact or tradeoff.',
+  "Prefer one ask_user question. Include up to three only when the decisions are independent and batching them avoids unnecessary round trips.",
+  "For review findings that genuinely require user disposition, use one question per independent finding and batch at most three; do not ask about findings your instructions already authorize you to fix.",
+  "A blank free-form answer means the user wants the question rephrased or split. Do not treat it as consent, rejection, or an empty factual answer.",
+];
+
+export function buildAskUserResultMessage(
+  outcome:
+    | { kind: "no-ui" }
+    | { kind: "cancelled" }
+    | { kind: "dismissed" }
+    | { kind: "answered"; answers: readonly AskUserAnswer[] },
+) {
+  switch (outcome.kind) {
+    case "no-ui":
+      return "No interactive UI is available, so the questions could not be shown. Ask the user in plain text instead.";
+    case "cancelled":
+      return "Cancelled";
+    case "dismissed":
+      return "User dismissed the questions without answering. Do not assume answers; proceed accordingly or ask differently.";
+    case "answered":
+      return `User answered:\n${outcome.answers
+        .map((answer) => {
+          const id = safeSingleLine(answer.id);
+          const value = answer.rephrase
+            ? "[rephrase or split this question]"
+            : safeSingleLine(
+                answer.custom ?? answer.selected ?? "(unanswered)",
+              );
+          const note = answer.note
+            ? ` — note: ${safeSingleLine(answer.note)}`
+            : "";
+          return `- ${id}: ${value}${note}`;
+        })
+        .join("\n")}`;
+  }
+}