@pi-archimedes/image-paste 2.12.0 → 2.13.0

package/README.md

@@ -18,13 +18,13 @@ Or the full suite instead:
 pi install npm:pi-archimedes
 ```
 
-New to Pi? Pi itself is a one-time global install and needs Node.js ≥ 22.19.0. If you need Pi, [its quickstart](https://github.com/earendil-works/pi/blob/main/packages/coding-agent/docs/quickstart.md) starts with `npm install -g --ignore-scripts @earendil-works/pi-coding-agent`. After installing Pi, choose one installation command above, then `cd` into your project, run `pi`, and use `/login` and `/model` inside the session. The [setup section](https://github.com/danielcherubini/pi-archimedes#setup) covers it end to end. `/reload` picks the extension up in a running session.
+New to Pi? Pi itself is a one-time global install and needs Node.js ≥ 22.19.0. If you need Pi, [its quickstart](https://github.com/earendil-works/pi/blob/main/packages/coding-agent/docs/quickstart.md) starts with `npm install -g --ignore-scripts @earendil-works/pi-coding-agent`. After installing Pi, choose one installation command above, then `cd` into your project, run `pi`, and use `/login` and `/model` inside the session. The [setup section](https://github.com/archimedes-codes/pi-archimedes#setup) covers it end to end. `/reload` picks the extension up in a running session.
 
 ## How it works
 
 - **Markers on paste** — pasting inserts a visible `[Image #1]` placeholder at the cursor; each paste gets the next number.
 - **Attachment on submit** — when you send the message, your text is scanned for markers and the matching queued images are attached to it. Delete a marker and its image is not attached — the text is the source of truth.
-- **Inline preview** — a preview of the attached images is sent and rendered in the TUI. Previews appear where your terminal renders inline images; on a terminal that can't show them, the image is still attached — only the preview falls back.
+- **Inline preview** — a preview of the attached images is sent and rendered in the TUI. Previews appear where your terminal renders inline images; on a terminal that can't show them, the image is still attached — only the preview falls back. Turn it off with `/archimedes` → Image Paste Preview, or `archimedes.imagePaste.preview: false`; images still attach.
 - **Same key, wider scope** — the paste key is Pi's own (`app.clipboard.pasteImage`), and taking it means covering everything it did, so with no image on the clipboard the handler falls back to what Pi does: copied **file paths** are inserted at the cursor with Pi's own spacing, and otherwise the clipboard **text** is inserted. One keypress produces one outcome, in that order: image, then paths, then text. Nothing on the clipboard leaves the draft untouched and says nothing, exactly as Pi does.
 - **Size guard** — 20 MiB **per image**, rejected with a clear message before it wastes context or hangs the submit.
 - **Bounded reads** — every clipboard read has a deadline (the same budget Pi gives its own clipboard commands), so a helper that stops answering — an X11/Wayland session that went unresponsive, say — reports `Clipboard paste failed: … timed out` instead of silently taking the paste key out of service for the rest of the session.
@@ -66,12 +66,13 @@ New to Pi? Pi itself is a one-time global install and needs Node.js ≥ 22.19.0.
 |---------|------|---------|-------------|
 | `enabled` | bool | `true` | On/off for the extension, via `/plugins` (suite-managed) |
 | `suppressNativePaste` | bool | `true` | `false` gives the paste key back to Pi: the suite's `app.clipboard.pasteImage` entry is removed from `~/.pi/agent/keybindings.json` (only that entry, only if the file holds nothing else but the suite's own `"$schema"` line) **and** no paste shortcut is registered. It also keeps the first-run offer silent — there is nothing to unbind — without spending `keybindingsPromptDone`, so turning it back on still brings the offer. You get Pi's paste and lose image attach / queue / preview on those keys. Applies at the next `/new` or `/reload`. Anything that is not the strict boolean `false` — `"false"`, `0` — keeps the default. |
+| `preview` | bool | `true` | `false` stops the inline preview of attached images on submit. Images still attach. Also in `/archimedes` → Image Paste Preview. Read on every submit, so no `/reload` needed. Anything that is not the strict boolean `false` keeps the default. |
 | `keybindingsPromptDone` | bool | `false` | Set true once the first-run keybindings.json offer has been answered (accept or decline); delete to re-open the offer |
 
 In the suite on/off is managed by the suite: toggle via `/plugins` (`archimedes.imagePaste.enabled`, default on).
 
 ## Part of the suite
 
-In [pi-archimedes](https://github.com/danielcherubini/pi-archimedes), image-paste works alongside the framed editor, the status bar, and the todo board; on/off is managed by the suite (`/plugins`, `archimedes.imagePaste.enabled`, default on).
+In [pi-archimedes](https://github.com/archimedes-codes/pi-archimedes), image-paste works alongside the framed editor, the status bar, and the todo board; on/off is managed by the suite (`/plugins`, `archimedes.imagePaste.enabled`, default on).
 
-← [Back to pi-archimedes](https://github.com/danielcherubini/pi-archimedes)
+← [Back to pi-archimedes](https://github.com/archimedes-codes/pi-archimedes)

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@pi-archimedes/image-paste",
-  "version": "2.12.0",
+  "version": "2.13.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/danielcherubini/pi-archimedes.git"
+    "url": "https://github.com/archimedes-codes/pi-archimedes.git"
   },
   "type": "module",
   "keywords": [
@@ -16,10 +16,11 @@
   "main": "./src/index.ts",
   "exports": {
     ".": "./src/index.ts",
-    "./keybinding-offer": "./src/keybinding-offer.ts"
+    "./keybinding-offer": "./src/keybinding-offer.ts",
+    "./settings": "./src/settings.ts"
   },
   "dependencies": {
-    "@pi-archimedes/core": "2.12.0"
+    "@pi-archimedes/core": "2.13.0"
   },
   "peerDependencies": {
     "@earendil-works/pi-coding-agent": ">=0.86.0",

package/src/index.ts

@@ -15,6 +15,7 @@ import {
 } from "./clipboard.js";
 import { runNativePasteRestore, suiteMayClaimPasteKey } from "./keybinding-offer.js";
 import { registerImagePreview, sendPreviewMessage } from "./preview.js";
+import { previewEnabled } from "./settings.js";
 import type { ClipboardImage, PendingImage, ImageMarker } from "./types.js";
 
 const MAX_FILE_SIZE_BYTES = 20 * 1024 * 1024; // 20MB
@@ -278,10 +279,12 @@ export function registerImagePaste(pi: ExtensionAPI): void {
     }
 
     // Send preview message for TUI display (images are invisible in user messages)
-    try {
-      sendPreviewMessage(pi, imagesToAttach);
-    } catch {
-      // Preview is optional — don't fail the submit
+    if (previewEnabled()) {
+      try {
+        sendPreviewMessage(pi, imagesToAttach);
+      } catch {
+        // Preview is optional — don't fail the submit
+      }
     }
 
     return {

package/src/preview-setting.test.ts

@@ -0,0 +1,164 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+
+// `archimedes.imagePaste.preview: false` skips the inline preview message on
+// submit; the image still attaches and the paste-time notify still fires.
+//
+// Settings: `core/settings-io` captures `join(getAgentDir(), "settings.json")`
+// at module load, hence one scratch dir for the whole file, rewritten per case.
+// Clipboard: the readers are mocked so a paste yields image bytes without
+// shelling out.
+
+const { tempDir, fs, join, mockReadClipboardImage } = vi.hoisted(() => {
+  const fs = require("node:fs");
+  const { join } = require("node:path");
+  const { tmpdir } = require("node:os");
+  const { randomUUID } = require("node:crypto");
+  const dir = join(tmpdir(), `image-paste-preview-setting-${randomUUID()}`);
+  fs.mkdirSync(dir, { recursive: true });
+  return { tempDir: dir, fs, join, mockReadClipboardImage: vi.fn() };
+});
+
+vi.mock("@earendil-works/pi-coding-agent", () => ({
+  getAgentDir: () => tempDir,
+  convertToPng: () => undefined,
+}));
+
+vi.mock("./clipboard.js", () => ({
+  readClipboardImage: mockReadClipboardImage,
+  readClipboardFilePaths: vi.fn(async () => null),
+  readClipboardText: vi.fn(async () => null),
+  buildPathInsertion: vi.fn(),
+  clipboardTextForEditor: vi.fn(),
+}));
+
+const { registerImagePaste, initImagePasteSession, shutdownImagePaste } = await import("./index.js");
+const { saveImagePastePreview } = await import("./settings.js");
+
+const NAMESPACE = "archimedes.imagePaste";
+const settingsPath = (): string => join(tempDir, "settings.json");
+
+function writeSettings(imagePaste: Record<string, unknown> | undefined): void {
+  const settings: Record<string, unknown> = {};
+  if (imagePaste !== undefined) settings[NAMESPACE] = imagePaste;
+  fs.writeFileSync(settingsPath(), JSON.stringify(settings), "utf-8");
+}
+
+type Handler = (...args: unknown[]) => unknown;
+
+interface SubmitResult {
+  action: string;
+  images?: unknown[];
+}
+
+/** Register once; `pasteAndSubmit()` then drives the same handlers each time. */
+function registerSession() {
+  const pi = {
+    on: vi.fn(),
+    registerShortcut: vi.fn(),
+    registerMessageRenderer: vi.fn(),
+    registerCommand: vi.fn(),
+    sendMessage: vi.fn(),
+  };
+  const notify = vi.fn();
+  const ctx = { hasUI: true, ui: { notify, pasteToEditor: vi.fn() } };
+
+  registerImagePaste(pi as never);
+  initImagePasteSession(ctx as never);
+
+  const paste = pi.registerShortcut.mock.calls[0]![1].handler as Handler;
+  const input = pi.on.mock.calls.find((call) => call[0] === "input")![1] as Handler;
+
+  /** Paste one image through the shortcut and submit it. */
+  async function pasteAndSubmit(): Promise<SubmitResult> {
+    await paste(ctx);
+    return (await input({ text: "[Image #1] look", source: "interactive" })) as SubmitResult;
+  }
+
+  return { pi, notify, pasteAndSubmit };
+}
+
+/** Register, paste one image through the shortcut, submit it; report what happened. */
+async function pasteAndSubmit() {
+  const session = registerSession();
+  const result = await session.pasteAndSubmit();
+  return { pi: session.pi, notify: session.notify, result };
+}
+
+beforeEach(() => {
+  fs.rmSync(settingsPath(), { force: true });
+  shutdownImagePaste();
+  mockReadClipboardImage.mockReset();
+  mockReadClipboardImage.mockResolvedValue({ bytes: new Uint8Array([1, 2, 3]), mimeType: "image/png" });
+});
+
+describe("archimedes.imagePaste.preview", () => {
+  it("sends the preview when the setting is absent", async () => {
+    const { pi, result } = await pasteAndSubmit();
+    expect(result.action).toBe("transform");
+    expect(pi.sendMessage).toHaveBeenCalledTimes(1);
+  });
+
+  it("sends the preview when preview is true", async () => {
+    writeSettings({ preview: true });
+    const { pi } = await pasteAndSubmit();
+    expect(pi.sendMessage).toHaveBeenCalledTimes(1);
+  });
+
+  it("skips the preview when preview is false, but still notifies and attaches", async () => {
+    writeSettings({ preview: false });
+    const { pi, notify, result } = await pasteAndSubmit();
+
+    expect(pi.sendMessage).not.toHaveBeenCalled();
+    expect(notify).toHaveBeenCalledWith("Image attached from clipboard.", "info");
+    expect(result.action).toBe("transform");
+    expect(result.images).toHaveLength(1);
+  });
+
+  it("re-reads the setting on each submit through the same registered handler (no /reload)", async () => {
+    const session = registerSession();
+
+    const first = await session.pasteAndSubmit();
+    expect(session.pi.sendMessage).toHaveBeenCalledTimes(1);
+    expect(first.action).toBe("transform");
+    expect(first.images).toHaveLength(1);
+
+    writeSettings({ preview: false });
+    const second = await session.pasteAndSubmit();
+    expect(session.pi.sendMessage).toHaveBeenCalledTimes(1);
+    expect(second.action).toBe("transform");
+    expect(second.images).toHaveLength(1);
+
+    writeSettings({ preview: true });
+    const third = await session.pasteAndSubmit();
+    expect(session.pi.sendMessage).toHaveBeenCalledTimes(2);
+    expect(third.images).toHaveLength(1);
+  });
+
+  it("treats a value that is not the boolean false as on", async () => {
+    for (const value of ["false", 0]) {
+      writeSettings({ preview: value });
+      shutdownImagePaste();
+      const { pi } = await pasteAndSubmit();
+      expect(pi.sendMessage, `preview=${JSON.stringify(value)}`).toHaveBeenCalledTimes(1);
+    }
+  });
+});
+
+describe("saveImagePastePreview (the /archimedes row)", () => {
+  it("merges preview into the namespace, keeps its other keys, and the next submit obeys it", async () => {
+    writeSettings({ enabled: true, suppressNativePaste: true, keybindingsPromptDone: true });
+    const session = registerSession();
+
+    saveImagePastePreview(false);
+    expect(JSON.parse(fs.readFileSync(settingsPath(), "utf-8"))[NAMESPACE]).toEqual({
+      enabled: true,
+      suppressNativePaste: true,
+      keybindingsPromptDone: true,
+      preview: false,
+    });
+
+    const result = await session.pasteAndSubmit();
+    expect(session.pi.sendMessage).not.toHaveBeenCalled();
+    expect(result.images).toHaveLength(1);
+  });
+});

package/src/settings.ts

@@ -0,0 +1,33 @@
+import type { SettingItem } from "@earendil-works/pi-tui";
+
+import { loadConfig, updateConfig } from "@pi-archimedes/core/settings-io";
+
+// Kept free of the package's main entry (clipboard, renderer) so meta's
+// /archimedes panel can import it without loading the lazily-loaded plugin.
+
+const NAMESPACE = "archimedes.imagePaste";
+
+/**
+ * `archimedes.imagePaste.preview`, default on. Only the strict boolean `false`
+ * disables it. Read per call so a settings change applies on the next submit.
+ */
+export function previewEnabled(): boolean {
+  return loadConfig<{ preview: boolean }>(NAMESPACE, { preview: true }).preview !== false;
+}
+
+export function getImagePasteSettingsItems(): SettingItem[] {
+  return [
+    {
+      id: "imagePastePreview",
+      label: "Image Paste Preview",
+      description: "Show an inline preview of pasted images after you submit",
+      currentValue: previewEnabled() ? "On" : "Off",
+      values: ["On", "Off"],
+    },
+  ];
+}
+
+/** Merges `preview` into the namespace; its other keys are kept. */
+export function saveImagePastePreview(on: boolean): void {
+  updateConfig<Record<string, unknown>>(NAMESPACE, {}, (cfg) => ({ ...cfg, preview: on }));
+}