pi-note 0.24.0 → 0.25.0

package/README.md

@@ -10,6 +10,9 @@ The extension and Python app share a repository but install separately.
 For server-provided UI instead of this Pinote-specific extension, see the opt-in
 [native MCP UI alternative](mcp/README.md). It uses a generic gateway host and has
 explicit initial-version limits; it is not activated by installing this extension.
+MCP users can separately enable the [optional Ctrl+D exit companion](mcp/README.md#optional-ctrld-exit-confirmation).
+It ships as `exit-confirm.ts` but is not loaded by default; do not load `index.ts`
+alongside MCP.
 
 ## Install
 

package/dist-mcp/mcp/server.js

@@ -18,6 +18,8 @@ const MIME = 'application/vnd.mcp-native-ui+json';
 const CONTEXT = 'native-ui/context';
 const exec = promisify(execFile);
 const noteCommand = process.env.PINOTE_NOTE_COMMAND || 'note';
+const dataHome = process.env.XDG_DATA_HOME;
+const database = join(dataHome && isAbsolute(dataHome) ? dataHome : join(homedir(), '.local/share'), 'pinote/notes.db');
 const icons = Object.fromEntries(['add', 'check', 'cross', 'note', 'open-app', 'external-link'].map((name) => [name, readFileSync(new URL(`../icons/${name}.txt`, import.meta.url), 'utf8').trim()]));
 const Proposal = z.object({ id: z.string().uuid(), text: z.string().min(1).max(4000), tag: z.string().trim().min(1).max(64).optional() }).strict();
 const Context = z.object({ conversationId: z.string().min(1).max(256), contextId: z.string().min(1).max(256).optional(), state: z.object({
@@ -29,7 +31,7 @@ const Action = z.object({ method: z.literal('native-ui/action'), params: z.objec
         uri: z.literal(URI), revision: z.string().min(1).max(256), action: z.string().min(1).max(256),
         value: z.union([z.string().max(20_000), z.number().finite(), z.boolean(), z.null()]).optional(), _meta: z.record(z.unknown()).optional(),
     }) });
-const server = new Server({ name: 'pinote', version: '0.24.0' }, { capabilities: { tools: {}, resources: {}, experimental: { 'native-ui-v1': {} } } });
+const server = new Server({ name: 'pinote', version: '0.25.0' }, { capabilities: { tools: {}, resources: {}, experimental: { 'native-ui-v1': {} } } });
 // Serialize complete read/check/write cycles even when a host sends parallel calls.
 let queue = Promise.resolve();
 function serial(run) {
@@ -431,7 +433,7 @@ server.setRequestHandler(CallToolRequestSchema, (request, extra) => serial(async
         }
         else
             throw new Error('Unknown tool');
-        return { content: [{ type: 'text', text: JSON.stringify(result) }], ...(outgoing ? { _meta: { 'native-ui/state': outgoing } } : {}) };
+        return { content: [{ type: 'text', text: JSON.stringify(result) }], ...(outgoing ? { _meta: { 'native-ui/state': outgoing } } : request.params.name === 'get_current' ? { _meta: { 'pinote/database': database } } : {}) };
     }
     catch (error) {
         return { isError: true, content: [{ type: 'text', text: String(error) }] };
@@ -441,8 +443,6 @@ server.setRequestHandler(CallToolRequestSchema, (request, extra) => serial(async
 // sessions. Stat polling survives missing files and atomic config replacement.
 server.oninitialized = () => {
     server.oninitialized = undefined;
-    const dataHome = process.env.XDG_DATA_HOME;
-    const database = join(dataHome && isAbsolute(dataHome) ? dataHome : join(homedir(), '.local/share'), 'pinote/notes.db');
     const paths = [database, `${database}-wal`, join(getAgentDir(), 'pi-note.json'), receiptDir];
     let timer;
     let closed = false;

package/exit-confirm.ts

@@ -0,0 +1,127 @@
+import { CustomEditor, type ExtensionAPI } from "@earendil-works/pi-coding-agent";
+import { truncateToWidth } from "@earendil-works/pi-tui";
+import { realpath } from "node:fs/promises";
+import { homedir } from "node:os";
+import { isAbsolute, join } from "node:path";
+import { stripVTControlCharacters } from "node:util";
+
+type Task = { id: number; text: string; updated_at: string; state: string };
+type Current = { task: Task | null; database?: string };
+const complete = "Complete task and exit";
+const leave = "Exit without completing";
+const clean = (value: string) => stripVTControlCharacters(value).replace(/[\x00-\x1f\x7f-\x9f]/gu, " ");
+function task(value: unknown): Task | null {
+  if (value === null) return null;
+  const item = value as Task | undefined;
+  if (!item || !Number.isSafeInteger(item.id) || item.id < 1 || typeof item.text !== "string" ||
+      typeof item.updated_at !== "string" || !item.updated_at ||
+      !["active", "in_progress", "done"].includes(item.state)) throw new Error("Invalid Pinote task response");
+  return item;
+}
+function same(left: Task | null, right: Task): boolean {
+  return left?.id === right.id && left.updated_at === right.updated_at && left.text === right.text && left.state === right.state;
+}
+
+// Optional MCP companion: deliberately absent from package.json's default extensions.
+export default function (pi: ExtensionAPI) {
+  let invalidate: (() => void) | undefined;
+  let stop: (() => void) | undefined;
+  const readCurrent = async (): Promise<Current> => {
+    const replies: { handled?: boolean; error?: string; result?: Promise<unknown> }[] = [];
+    pi.events.emit("gateway:query-service-tool", {
+      service: "pinote", tool: "get_current",
+      respond: (reply: typeof replies[number]) => {
+        if (reply.handled) { replies.push(reply); void reply.result?.catch(() => {}); }
+      },
+    });
+    if (replies.length !== 1 || replies[0].error || !replies[0].result) {
+      throw new Error(replies[0]?.error || "Pinote gateway service unavailable; use /quit to exit without completing");
+    }
+    const result = await replies[0].result as {
+      isError?: boolean; content?: { type: string; text?: string }[]; _meta?: Record<string, unknown>;
+    };
+    if (result.isError) throw new Error(result.content?.find((item) => item.type === "text")?.text || "Pinote query failed");
+    const raw = result.content?.find((item) => item.type === "text")?.text;
+    if (raw === undefined) throw new Error("Missing Pinote task response");
+    const value = task(JSON.parse(raw));
+    if (value && !["active", "in_progress"].includes(value.state)) throw new Error("Pinote task is no longer active");
+    const database = result._meta?.["pinote/database"];
+    return { task: value, database: typeof database === "string" ? database : undefined };
+  };
+  pi.on("session_start", (_event, ctx) => {
+    if (ctx.mode !== "tui" || !ctx.hasUI) return;
+    const previous = ctx.ui.getEditorComponent();
+    let alive = true, pending = false, epoch = 0;
+    let controller: AbortController | undefined;
+    invalidate = () => { epoch++; controller?.abort(); };
+    const exit = async () => {
+      if (pending || !alive) return;
+      pending = true;
+      const generation = epoch;
+      const operation = controller = new AbortController();
+      const current = () => alive && generation === epoch && !operation.signal.aborted &&
+        ctx.ui.getEditorText().length === 0;
+      const shutdown = () => { if (!ctx.isIdle()) ctx.abort(); ctx.shutdown(); };
+      const run = async (args: string[]) => {
+        if (!current() || !ctx.isIdle()) throw new Error("Pinote exit cancelled: session changed or became busy");
+        const result = await pi.exec(process.env.PINOTE_NOTE_COMMAND || "note", args, { timeout: 10_000, signal: operation.signal });
+        if (result.killed || result.code !== 0) throw new Error(clean(result.stderr || result.stdout || "Pinote CLI failed or timed out"));
+        return result.stdout;
+      };
+      try {
+        const selected = await readCurrent();
+        if (!current()) return;
+        if (!selected.task) { shutdown(); return; }
+        const approved = selected.task;
+        const title = truncateToWidth(clean(approved.text.split("\n", 1)[0]), 70);
+        const choice = await ctx.ui.select(`Pinote · ${title}`, [complete, leave, "Cancel"], { signal: operation.signal });
+        if (!current()) return;
+        if (choice === leave) { shutdown(); return; }
+        if (choice !== complete) return;
+        if (!ctx.isIdle()) throw new Error("Wait for Pi to become idle before completing a task");
+        const dataHome = process.env.XDG_DATA_HOME;
+        const localDatabase = join(dataHome && isAbsolute(dataHome) ? dataHome : join(homedir(), ".local/share"), "pinote/notes.db");
+        if (!selected.database || !isAbsolute(selected.database) ||
+            await realpath(selected.database) !== await realpath(localDatabase)) {
+          throw new Error("Pinote database mismatch: update the MCP server and use the same XDG_DATA_HOME in Pi and the service");
+        }
+        const version = (await run(["--version"])).trim();
+        const match = /^pinote (\d+)\.(\d+)\.(\d+)$/.exec(version);
+        if (!match || Number(match[1]) === 0 && Number(match[2]) < 12) throw new Error("Pinote exit confirmation requires note 0.12.0+");
+        const local = task(JSON.parse(await run(["--no-notify", "agent", "get", String(approved.id)])));
+        const fresh = await readCurrent();
+        if (!same(local, approved) || !same(fresh.task, approved) || fresh.database !== selected.database) {
+          throw new Error("Pinote task changed; inspect it before retrying");
+        }
+        const done = task(JSON.parse(await run(["--no-notify", "agent", "done", String(approved.id), "--expected-updated-at", approved.updated_at])));
+        if (done?.id !== approved.id || done.state !== "done") throw new Error("Unexpected completion response; inspect the task before retrying");
+        if (current() && !(await readCurrent()).task && current()) shutdown();
+        else if (current()) ctx.ui.notify("Task completed; Pi stayed open because the selection changed", "info");
+      } catch (error) {
+        if (alive && generation === epoch) ctx.ui.notify(`Pinote: ${clean(String(error))}. Pi stayed open; inspect the task before retrying. /quit exits without completing.`, "error");
+      } finally { pending = false; }
+    };
+    const factory: NonNullable<ReturnType<typeof ctx.ui.getEditorComponent>> = (tui, theme, keybindings) => {
+      const editor = previous ? previous(tui, theme, keybindings) : new CustomEditor(tui, theme, keybindings);
+      const handleInput = editor.handleInput.bind(editor);
+      editor.handleInput = (data) => {
+        if (keybindings.matches(data, "app.exit") && editor.getText().length === 0) { void exit(); return; }
+        handleInput(data);
+      };
+      return editor;
+    };
+    ctx.ui.setEditorComponent(factory);
+    stop = () => {
+      alive = false;
+      invalidate?.();
+      if (ctx.ui.getEditorComponent() === factory) ctx.ui.setEditorComponent(previous);
+    };
+  });
+  pi.on("session_shutdown", () => { stop?.(); stop = invalidate = undefined; });
+  // Retire in-flight dialogs/reads before navigation or a new agent run can act.
+  const interrupted = () => { invalidate?.(); };
+  pi.on("session_before_switch", interrupted);
+  pi.on("session_before_fork", interrupted);
+  pi.on("session_before_tree", interrupted);
+  pi.on("agent_start", interrupted);
+}

package/mcp/README.md

@@ -103,6 +103,40 @@ have saved the session for resume persistence. Existing extension selections are
 not imported. Changing the gateway config path or service name starts a separate
 selection namespace.
 
+## Optional Ctrl+D exit confirmation
+
+`pi-note` 0.25.0 ships `pi/exit-confirm.ts`, a disabled-by-default **companion** to this
+MCP setup, not the old `pi/index.ts` extension. It requires Pi 0.99.1+, a gateway
+supporting `gateway:query-service-tool`, and this version of the Pinote MCP server
+registered as `pinote`. Enable it for one launch:
+
+```bash
+PINOTE_NOTE_COMMAND=/absolute/path/to/pinote/.venv/bin/note \
+  pi -e /absolute/path/to/pinote/pi/exit-confirm.ts
+```
+
+For persistent use, add that absolute extension path to `extensions` in Pi's
+user `settings.json`, preserving other entries, then `/reload`. Remove the path
+and `/reload` to disable it. Installing `pi-note` does not enable the companion.
+Load it after other editor extensions so it can wrap their editor without replacing
+its normal input behavior.
+
+With an empty editor, Ctrl+D (or your configured `app.exit` key) offers **Complete
+task and exit**, **Exit without completing**, or **Cancel**. Escape cancels. With
+no selected task Pi exits immediately; nonempty text keeps normal editing behavior.
+Completion requires idle Pi, rechecks the selection and displayed revision, and
+uses the local CLI without notifications. Query/completion failures leave Pi open;
+inspect the task before retrying because a failed write may have committed. `/quit`
+and other exit paths bypass the companion and never complete a task.
+
+Pi and the MCP service must use the **same local database**: match `XDG_DATA_HOME`
+(and HOME when using defaults). Set `PINOTE_NOTE_COMMAND` in Pi's environment if
+`note` is not on PATH; its executable must use that same database. The companion
+compares the server's database path and task revision before writing; it does not
+fall back to a folder selection or create another selection store. Remote Pinote
+services are unsupported. RPC/print mode is unaffected; no Pi/gateway patch or
+personal configuration change is made by installation.
+
 ## Task-offer guidance
 
 Before multi-step implementation or configuration migrations, agents should call

package/mcp/server.ts

@@ -19,6 +19,8 @@ const MIME = 'application/vnd.mcp-native-ui+json';
 const CONTEXT = 'native-ui/context';
 const exec = promisify(execFile);
 const noteCommand = process.env.PINOTE_NOTE_COMMAND || 'note';
+const dataHome = process.env.XDG_DATA_HOME;
+const database = join(dataHome && isAbsolute(dataHome) ? dataHome : join(homedir(), '.local/share'), 'pinote/notes.db');
 const icons = Object.fromEntries(['add', 'check', 'cross', 'note', 'open-app', 'external-link'].map((name) => [name, readFileSync(new URL(`../icons/${name}.txt`, import.meta.url), 'utf8').trim()]));
 const Proposal = z.object({ id: z.string().uuid(), text: z.string().min(1).max(4000), tag: z.string().trim().min(1).max(64).optional() }).strict();
 const Context = z.object({ conversationId: z.string().min(1).max(256), contextId: z.string().min(1).max(256).optional(), state: z.object({
@@ -34,7 +36,7 @@ const Action = z.object({ method: z.literal('native-ui/action'), params: z.objec
   uri: z.literal(URI), revision: z.string().min(1).max(256), action: z.string().min(1).max(256),
   value: z.union([z.string().max(20_000), z.number().finite(), z.boolean(), z.null()]).optional(), _meta: z.record(z.unknown()).optional(),
 }) });
-const server = new Server({ name: 'pinote', version: '0.24.0' }, { capabilities: { tools: {}, resources: {}, experimental: { 'native-ui-v1': {} } } });
+const server = new Server({ name: 'pinote', version: '0.25.0' }, { capabilities: { tools: {}, resources: {}, experimental: { 'native-ui-v1': {} } } });
 // Serialize complete read/check/write cycles even when a host sends parallel calls.
 let queue = Promise.resolve();
 function serial<T>(run: () => Promise<T>): Promise<T> {
@@ -334,15 +336,13 @@ server.setRequestHandler(CallToolRequestSchema, (request, extra) => serial(async
       result = JSON.parse(await note(['agent', 'update', String(task.id), '--expected-updated-at', args.expected_updated_at, '--set-json', JSON.stringify(args.set), ...args.remove.map((key) => `--remove=${key}`)], extra.signal));
       await server.notification({ method: 'notifications/native-ui/changed', params: { uri: URI } });
     } else throw new Error('Unknown tool');
-    return { content: [{ type: 'text', text: JSON.stringify(result) }], ...(outgoing ? { _meta: { 'native-ui/state': outgoing } } : {}) };
+    return { content: [{ type: 'text', text: JSON.stringify(result) }], ...(outgoing ? { _meta: { 'native-ui/state': outgoing } } : request.params.name === 'get_current' ? { _meta: { 'pinote/database': database } } : {}) };
   } catch (error) { return { isError: true, content: [{ type: 'text', text: String(error) }] }; }
 }));
 // Every MCP process observes shared storage, including writes by CLI/GTK/other
 // sessions. Stat polling survives missing files and atomic config replacement.
 server.oninitialized = () => {
   server.oninitialized = undefined;
-  const dataHome = process.env.XDG_DATA_HOME;
-  const database = join(dataHome && isAbsolute(dataHome) ? dataHome : join(homedir(), '.local/share'), 'pinote/notes.db');
   const paths = [database, `${database}-wal`, join(getAgentDir(), 'pi-note.json'), receiptDir];
   let timer: ReturnType<typeof setTimeout> | undefined;
   let closed = false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-note",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "description": "Persistent pinote tasks, Markdown handoffs, and task status for Pi",
   "license": "MIT",
   "type": "module",
@@ -27,6 +27,7 @@
   },
   "files": [
     "index.ts",
+    "exit-confirm.ts",
     "footer-status.ts",
     "footer-links.ts",
     "footer-config.ts",