@@ -232,6 +247,15 @@ (".edit-row")!.click();
+ expect(navigator.clipboard.writeText).toHaveBeenCalledWith(
+ "/deck/slide.svg",
+ );
+ expect(editMenu.classList.contains("open")).toBe(false);
+ expect(editToast.classList.contains("visible")).toBe(true);
+ // The full path, not just the filename — a bare "slide.svg" would read as
+ // though only the name had been copied.
+ expect(editToastText.textContent).toBe("Copied /deck/slide.svg");
+});
+
+test("clicking the toast's close button dismisses it early", () => {
+ vi.useFakeTimers();
+ state.slides = [
+ slideWith({
+ label: "Layout",
+ name: "slide.svg",
+ path: "/deck/slide.svg",
+ }),
+ ];
+ initEditMenu({ svg: false, default: false }, 7778);
+ btnEdit.click();
+ editMenu.querySelector(".edit-row")!.click();
+ expect(editToast.classList.contains("visible")).toBe(true);
+ editToastClose.click();
+ expect(editToast.classList.contains("visible")).toBe(false);
+ // The pending auto-hide timeout must also be cleared, not just overridden by
+ // the manual dismiss, otherwise it could re-fire (harmlessly, but sloppily)
+ // or clobber a *later* toast's own timer.
+ vi.advanceTimersByTime(3000);
+ expect(editToast.classList.contains("visible")).toBe(false);
+ vi.useRealTimers();
+});
+
+test("a second copy in quick succession restarts the auto-hide timer", () => {
+ vi.useFakeTimers();
+ state.slides = [
+ slideWith(
+ { label: "Layout", name: "a.svg", path: "/deck/a.svg" },
+ { label: "Content", name: "b.md", path: "/deck/b.md" },
+ ),
+ ];
+ initEditMenu({ svg: false, default: false }, 7778);
+ btnEdit.click();
+ editMenu.querySelectorAll(".edit-row")[0].click();
+ vi.advanceTimersByTime(2000); // most of the way to the first toast's timeout
+ btnEdit.click();
+ editMenu.querySelectorAll(".edit-row")[1].click();
+ vi.advanceTimersByTime(2000); // would have closed the first toast by now
+ expect(editToast.classList.contains("visible")).toBe(true);
+ expect(editToastText.textContent).toBe("Copied /deck/b.md");
+ vi.advanceTimersByTime(1000); // completes the second toast's own 3000ms
+ expect(editToast.classList.contains("visible")).toBe(false);
+ vi.useRealTimers();
+});
+
+test("the copy confirmation times itself out", () => {
+ vi.useFakeTimers();
+ state.slides = [
+ slideWith({
+ label: "Layout",
+ name: "slide.svg",
+ path: "/deck/slide.svg",
+ }),
+ ];
+ initEditMenu({ svg: false, default: false }, 7778);
+ btnEdit.click();
+ editMenu.querySelector(".edit-row")!.click();
+ expect(editToast.classList.contains("visible")).toBe(true);
+ vi.advanceTimersByTime(3000);
+ expect(editToast.classList.contains("visible")).toBe(false);
+ vi.useRealTimers();
+});
+
+test("multiple editable files open a dropdown instead of acting directly", () => {
+ state.slides = [
+ slideWith(
+ { label: "Layout", name: "slide.svg", path: "/deck/slide.svg" },
+ { label: "Content", name: "slide.md", path: "/deck/slide.md" },
+ ),
+ ];
+ initEditMenu({ svg: false, default: false }, 7778);
+ btnEdit.click();
+ expect(editMenu.classList.contains("open")).toBe(true);
+ expect(navigator.clipboard.writeText).not.toHaveBeenCalled();
+});
+
+test("opening the edit dropdown closes another open menu (e.g. sync)", () => {
+ state.slides = [
+ slideWith(
+ { label: "Layout", name: "slide.svg", path: "/deck/slide.svg" },
+ { label: "Content", name: "slide.md", path: "/deck/slide.md" },
+ ),
+ ];
+ const closeOther = vi.fn();
+ menuOpened(closeOther);
+ initEditMenu({ svg: false, default: false }, 7778);
+ btnEdit.click();
+ expect(closeOther).toHaveBeenCalledOnce();
+ expect(editMenu.classList.contains("open")).toBe(true);
+});
+
+test("clicking a dropdown row acts on that file and closes the menu", () => {
+ state.slides = [
+ slideWith(
+ { label: "Layout", name: "slide.svg", path: "/deck/slide.svg" },
+ { label: "Content", name: "slide.md", path: "/deck/slide.md" },
+ ),
+ ];
+ initEditMenu({ svg: false, default: false }, 7778);
+ btnEdit.click();
+ const contentRow = Array.from(
+ editMenu.querySelectorAll(".edit-row"),
+ ).find(
+ (r) => r.querySelector(".edit-row-label")?.textContent === "Content",
+ )!;
+ contentRow.click();
+ expect(navigator.clipboard.writeText).toHaveBeenCalledWith(
+ "/deck/slide.md",
+ );
+ expect(editMenu.classList.contains("open")).toBe(false);
+});
+
+test("a configured command with a live WS connection sends an edit message instead of copying", () => {
+ state.slides = [
+ slideWith({
+ label: "Layout",
+ name: "slide.svg",
+ path: "/deck/slide.svg",
+ }),
+ ];
+ const send = vi.fn();
+ state.ws = { send, readyState: WebSocket.OPEN } as unknown as WebSocket;
+ initEditMenu({ svg: true, default: false }, 7778);
+ btnEdit.click();
+ editMenu.querySelector(".edit-row")!.click();
+ expect(send).toHaveBeenCalledWith(
+ JSON.stringify({ type: "edit", path: "/deck/slide.svg" }),
+ );
+ expect(navigator.clipboard.writeText).not.toHaveBeenCalled();
+ expect(editToast.classList.contains("visible")).toBe(true);
+ expect(editToastText.textContent).toBe("Opened slide.svg");
+});
+
+test("a configured command falls back to clipboard when the WS is not open", () => {
+ state.slides = [
+ slideWith({
+ label: "Layout",
+ name: "slide.svg",
+ path: "/deck/slide.svg",
+ }),
+ ];
+ const send = vi.fn();
+ state.ws = { send, readyState: WebSocket.CLOSED } as unknown as WebSocket;
+ initEditMenu({ svg: true, default: false }, 7778);
+ btnEdit.click();
+ editMenu.querySelector(".edit-row")!.click();
+ expect(send).not.toHaveBeenCalled();
+ expect(navigator.clipboard.writeText).toHaveBeenCalledWith(
+ "/deck/slide.svg",
+ );
+});
+
+test("an unconfigured file kind falls back to clipboard even with a live WS", () => {
+ state.slides = [
+ slideWith({
+ label: "Layout",
+ name: "slide.svg",
+ path: "/deck/slide.svg",
+ }),
+ ];
+ const send = vi.fn();
+ state.ws = { send, readyState: WebSocket.OPEN } as unknown as WebSocket;
+ initEditMenu({ svg: false, default: false }, 7778);
+ btnEdit.click();
+ editMenu.querySelector(".edit-row")!.click();
+ expect(send).not.toHaveBeenCalled();
+ expect(navigator.clipboard.writeText).toHaveBeenCalledWith(
+ "/deck/slide.svg",
+ );
+});
+
+test("the general command also applies to SVG files when no SVG-specific override is set", () => {
+ state.slides = [
+ slideWith({
+ label: "Layout",
+ name: "slide.svg",
+ path: "/deck/slide.svg",
+ }),
+ ];
+ const send = vi.fn();
+ state.ws = { send, readyState: WebSocket.OPEN } as unknown as WebSocket;
+ initEditMenu({ svg: false, default: true }, 7778);
+ btnEdit.click();
+ editMenu.querySelector(".edit-row")!.click();
+ expect(send).toHaveBeenCalledWith(
+ JSON.stringify({ type: "edit", path: "/deck/slide.svg" }),
+ );
+ expect(navigator.clipboard.writeText).not.toHaveBeenCalled();
+});
+
+test("showEditError shows a red, non-auto-dismissing toast", () => {
+ vi.useFakeTimers();
+ showEditError("failed to launch edit command 'nope': not found");
+ expect(editToast.classList.contains("visible")).toBe(true);
+ expect(editToast.classList.contains("error")).toBe(true);
+ expect(editToastText.textContent).toBe(
+ "failed to launch edit command 'nope': not found",
+ );
+ // Unlike a success toast, an error stays until dismissed — it's diagnostic
+ // text worth reading, not a transient confirmation.
+ vi.advanceTimersByTime(10_000);
+ expect(editToast.classList.contains("visible")).toBe(true);
+ vi.useRealTimers();
+});
+
+test("the close button dismisses an error toast too", () => {
+ showEditError("something went wrong");
+ editToastClose.click();
+ expect(editToast.classList.contains("visible")).toBe(false);
+});
+
+test("a success toast after an error clears the error styling", () => {
+ state.slides = [
+ slideWith({
+ label: "Layout",
+ name: "slide.svg",
+ path: "/deck/slide.svg",
+ }),
+ ];
+ showEditError("something went wrong");
+ expect(editToast.classList.contains("error")).toBe(true);
+ initEditMenu({ svg: false, default: false }, 7778);
+ btnEdit.click();
+ editMenu.querySelector(".edit-row")!.click();
+ expect(editToast.classList.contains("error")).toBe(false);
+ expect(editToast.classList.contains("visible")).toBe(true);
+});
diff --git a/src/ts/presenter/edit.ts b/src/ts/presenter/edit.ts
new file mode 100644
index 00000000..06aab484
--- /dev/null
+++ b/src/ts/presenter/edit.ts
@@ -0,0 +1,190 @@
+import type { EditableFile, EditCommandsConfig } from "../shared/types";
+import { menuClosed, menuOpened } from "./menus";
+import { state } from "./state";
+
+// Status-bar control for editing the current slide's source file(s). Owns the
+// button + dropdown DOM (structurally mirrors syncmenu.ts).
+//
+// Default action is copying the resolved path to the clipboard — universal,
+// works with any editor via paste-navigate. INKFLOW_EDIT_CMD / INKFLOW_EDIT_CMD_SVG
+// (server env vars, baked into EditCommandsConfig at page load) override that:
+// INKFLOW_EDIT_CMD_SVG overrides INKFLOW_EDIT_CMD for SVG files, which otherwise
+// covers every file kind. When configured *and* there's a live server connection,
+// the path is sent to the server to launch instead. The live-connection check
+// (not just the boot-time config flag) mirrors websocket.ts's postToPeer
+// reasoning — check the real transport, not a static flag — so a disconnected
+// server degrades to clipboard-copy instead of silently dropping the click.
+//
+// Hidden entirely when wsPort is null (a static build/export): there is no server
+// to run a command, and copying the deck author's local dev-machine path to an
+// arbitrary viewer's clipboard is not a sensible default there.
+
+const btnEdit = document.getElementById("btn-edit")!;
+const editMenu = document.getElementById("edit-menu")!;
+const editWrap = btnEdit.closest(".edit-wrap")!;
+const editToast = document.getElementById("edit-toast")!;
+const editToastText = document.getElementById("edit-toast-text")!;
+const editToastClose = document.getElementById("edit-toast-close")!;
+
+// Must match the CSS animation duration on #edit-toast-progress (overlays.css).
+const TOAST_DURATION_MS = 3000;
+
+let config: EditCommandsConfig = { default: false, svg: false };
+let toastTimeout: ReturnType | null = null;
+
+editToastClose.addEventListener("click", () => hideToast());
+
+// One small icon per editableFiles label — a plain signifier, not decoration, so
+// entries with the same generic label (several "Parent" rows) still read apart at
+// a glance alongside their filename. Trusted, fixed markup (never file/user data).
+const ROW_ICONS: Record = {
+ Layout: ``,
+ Parent: ``,
+ Content: ``,
+ Notes: ``,
+ Deck: ``,
+};
+
+function isConfigured(file: EditableFile): boolean {
+ // config.svg overrides config.default for SVG files; every other kind
+ // always uses the general command — mirrors edit.py's command_for.
+ if (file.path.toLowerCase().endsWith(".svg")) {
+ return config.svg || config.default;
+ }
+ return config.default;
+}
+
+function hideToast(): void {
+ if (toastTimeout) clearTimeout(toastTimeout);
+ editToast.classList.remove("visible");
+ toastTimeout = null;
+}
+
+// Flashes a confirmation styled like the #log-banner message boxes (same
+// surface/border/shadow treatment, an accent colour instead of its warning
+// yellow), with its own close button and (for a success message) a shrinking
+// progress bar (pure CSS, see overlays.css) showing time left before it
+// dismisses itself. An error stays until manually dismissed — it's diagnostic
+// text the click that triggered it didn't expect, worth more than a glance.
+function flashToast(
+ message: string,
+ kind: "success" | "error" = "success",
+): void {
+ editToastText.textContent = message;
+ editToast.classList.toggle("error", kind === "error");
+ // Drop .visible and force a reflow before re-adding it, even if the toast is
+ // already showing (two edits in quick succession) — otherwise the browser
+ // never sees the class go away and won't restart the progress-bar animation.
+ editToast.classList.remove("visible");
+ void editToast.offsetWidth;
+ editToast.classList.add("visible");
+ if (toastTimeout) clearTimeout(toastTimeout);
+ toastTimeout =
+ kind === "error" ? null : setTimeout(hideToast, TOAST_DURATION_MS);
+}
+
+// Called from websocket.ts when the server replies with an "edit-error"
+// message: the configured command failed to launch (e.g. the binary isn't on
+// PATH). Without this, a failed launch was only ever logged server-side —
+// invisible from the browser tab where the click actually happened.
+export function showEditError(message: string): void {
+ flashToast(message, "error");
+}
+
+function actOn(file: EditableFile): void {
+ if (
+ isConfigured(file) &&
+ state.ws &&
+ state.ws.readyState === WebSocket.OPEN
+ ) {
+ state.ws.send(JSON.stringify({ type: "edit", path: file.path }));
+ flashToast(`Opened ${file.name}`);
+ return;
+ }
+ try {
+ void navigator.clipboard.writeText(file.path);
+ // The full path, not just file.name: a bare filename here would read as
+ // though only the name (not the whole path) had been copied.
+ flashToast(`Copied ${file.path}`);
+ } catch (_) {}
+}
+
+// ── Button / menu rendering ──────────────────────────────────────────────────
+
+export function renderEditButton(): void {
+ const files = state.slides[state.slideIndex]?.editableFiles ?? [];
+ editMenu.innerHTML = "";
+ for (const file of files) {
+ const row = document.createElement("button");
+ row.type = "button";
+ row.className = "edit-row";
+ row.insertAdjacentHTML("beforeend", ROW_ICONS[file.label] ?? "");
+ const text = document.createElement("span");
+ text.className = "edit-row-text";
+ const label = document.createElement("span");
+ label.className = "edit-row-label";
+ label.textContent = file.label;
+ const name = document.createElement("span");
+ name.className = "edit-row-name";
+ name.textContent = file.name;
+ text.append(label, name);
+ row.appendChild(text);
+ row.addEventListener("click", () => {
+ actOn(file);
+ closeMenu();
+ });
+ editMenu.appendChild(row);
+ }
+}
+
+// ── Menu open/close ────────────────────────────────────────────────────────────
+
+function onDocClick(e: MouseEvent): void {
+ const t = e.target as Node;
+ if (!btnEdit.contains(t) && !editMenu.contains(t)) closeMenu();
+}
+
+function onKeydown(e: KeyboardEvent): void {
+ if (e.key === "Escape") {
+ closeMenu();
+ btnEdit.focus();
+ }
+}
+
+function openMenu(): void {
+ editMenu.classList.add("open");
+ btnEdit.setAttribute("aria-expanded", "true");
+ document.addEventListener("click", onDocClick);
+ document.addEventListener("keydown", onKeydown);
+ menuOpened(closeMenu);
+}
+
+function closeMenu(): void {
+ if (!editMenu.classList.contains("open")) return;
+ editMenu.classList.remove("open");
+ btnEdit.setAttribute("aria-expanded", "false");
+ document.removeEventListener("click", onDocClick);
+ document.removeEventListener("keydown", onKeydown);
+ menuClosed(closeMenu);
+}
+
+function toggleMenu(): void {
+ if (editMenu.classList.contains("open")) closeMenu();
+ else openMenu();
+}
+
+export function initEditMenu(
+ cfg: EditCommandsConfig,
+ wsPort: number | null,
+): void {
+ if (!wsPort) {
+ editWrap.style.display = "none";
+ return;
+ }
+ config = cfg;
+ btnEdit.addEventListener("click", (e) => {
+ e.stopPropagation();
+ toggleMenu();
+ });
+ renderEditButton();
+}
diff --git a/src/ts/presenter/main.ts b/src/ts/presenter/main.ts
index 83f0971b..3ab3125c 100644
--- a/src/ts/presenter/main.ts
+++ b/src/ts/presenter/main.ts
@@ -1,3 +1,4 @@
+import { initEditMenu } from "./edit";
import { renderPv, updatePvClock } from "./pv";
import { state } from "./state";
import { readURL } from "./status";
@@ -17,6 +18,7 @@ import "./keyboard";
const INITIAL_SLIDES = __SLIDES_JSON__;
const INITIAL_TRANSITIONS = __TRANSITIONS_JSON__;
const WS_PORT = __WS_PORT__;
+const EDIT_COMMANDS = __EDIT_COMMANDS_JSON__;
const INITIAL_ERROR = __ERROR_JSON__;
const INITIAL_LOGS = __LOGS_JSON__;
@@ -40,6 +42,7 @@ window.addEventListener("popstate", () => {
loadSyncMode();
initSyncMenu();
initWindowSync(WS_PORT);
+initEditMenu(EDIT_COMMANDS, WS_PORT);
// Capture deep-link authority before loadSlide()/syncURL() rewrites the URL.
const deepLinked = readURL();
loadSlide();
diff --git a/src/ts/presenter/menus.test.ts b/src/ts/presenter/menus.test.ts
new file mode 100644
index 00000000..66f79522
--- /dev/null
+++ b/src/ts/presenter/menus.test.ts
@@ -0,0 +1,45 @@
+import { beforeEach, expect, test, vi } from "vitest";
+import { menuClosed, menuOpened } from "./menus";
+
+// menus.ts holds one bit of module-level state (which close fn is "active"), so
+// tests must reset it between runs rather than relying on module isolation.
+beforeEach(() => {
+ // Drain any leftover active closer from a previous test without invoking it.
+ const noop = () => {};
+ menuOpened(noop);
+ menuClosed(noop);
+});
+
+test("opening a second menu closes the first", () => {
+ const closeA = vi.fn();
+ const closeB = vi.fn();
+ menuOpened(closeA);
+ menuOpened(closeB);
+ expect(closeA).toHaveBeenCalledOnce();
+ expect(closeB).not.toHaveBeenCalled();
+});
+
+test("re-opening the same menu does not close itself", () => {
+ const close = vi.fn();
+ menuOpened(close);
+ menuOpened(close);
+ expect(close).not.toHaveBeenCalled();
+});
+
+test("menuClosed clears the active menu so the next open closes nothing", () => {
+ const closeA = vi.fn();
+ const closeB = vi.fn();
+ menuOpened(closeA);
+ menuClosed(closeA);
+ menuOpened(closeB);
+ expect(closeA).not.toHaveBeenCalled();
+});
+
+test("menuClosed is a no-op when it isn't the active menu", () => {
+ const closeA = vi.fn();
+ const closeB = vi.fn();
+ menuOpened(closeA);
+ menuClosed(closeB); // closeB was never the active one
+ menuOpened(closeB);
+ expect(closeA).toHaveBeenCalledOnce(); // still closed normally by B's open
+});
diff --git a/src/ts/presenter/menus.ts b/src/ts/presenter/menus.ts
new file mode 100644
index 00000000..41ec390b
--- /dev/null
+++ b/src/ts/presenter/menus.ts
@@ -0,0 +1,16 @@
+// Coordinates status-bar dropdown menus (sync, edit, …) so opening one closes
+// any other that's open. Each menu owns its own DOM/open-close logic (syncmenu.ts,
+// edit.ts) and just reports through here — this module holds no menu state of its
+// own beyond "which close function is currently active", so two menus never import
+// each other directly.
+
+let activeClose: (() => void) | null = null;
+
+export function menuOpened(close: () => void): void {
+ if (activeClose && activeClose !== close) activeClose();
+ activeClose = close;
+}
+
+export function menuClosed(close: () => void): void {
+ if (activeClose === close) activeClose = null;
+}
diff --git a/src/ts/presenter/overview.test.ts b/src/ts/presenter/overview.test.ts
index 9f2b2739..8463db36 100644
--- a/src/ts/presenter/overview.test.ts
+++ b/src/ts/presenter/overview.test.ts
@@ -45,6 +45,11 @@ beforeAll(async () => {
+
+
+
+
+
`;
// computeStageFlip() divides stage/thumbnail rect sizes; happy-dom has no
@@ -87,12 +92,14 @@ beforeEach(() => {
svg: '',
title: "A",
notes: "",
+ editableFiles: [],
},
{
id: "b",
svg: '',
title: "B",
notes: "",
+ editableFiles: [],
},
];
state.slideIndex = 0;
diff --git a/src/ts/presenter/picker.test.ts b/src/ts/presenter/picker.test.ts
index 5be2b0a7..1c6e6833 100644
--- a/src/ts/presenter/picker.test.ts
+++ b/src/ts/presenter/picker.test.ts
@@ -39,6 +39,11 @@ beforeAll(async () => {
+
+
+
+
+
`;
vi.resetModules();
({ filterPicker } = await import("./picker"));
@@ -53,7 +58,15 @@ beforeEach(() => {
describe("picker title escaping (F-018)", () => {
test("a malicious title renders inert instead of injecting a node", () => {
const evil = `
`;
- state.slides = [{ id: "a", svg: "", title: evil, notes: "" }];
+ state.slides = [
+ {
+ id: "a",
+ svg: "",
+ title: evil,
+ notes: "",
+ editableFiles: [],
+ },
+ ];
filterPicker("");
diff --git a/src/ts/presenter/pv.ts b/src/ts/presenter/pv.ts
index 3a74a832..662c16cb 100644
--- a/src/ts/presenter/pv.ts
+++ b/src/ts/presenter/pv.ts
@@ -1,6 +1,7 @@
import { buildStepRing } from "../shared/ring";
import { applyStepInstant } from "../shared/step";
import { parseViewBox } from "../shared/viewbox";
+import { renderEditButton } from "./edit";
import { state } from "./state";
import { maxStep } from "./status";
@@ -124,6 +125,7 @@ export function renderPv(): void {
updatePvInfo();
renderPvNext();
renderPvNotes();
+ renderEditButton();
}
export function togglePv(): void {
diff --git a/src/ts/presenter/syncmenu.ts b/src/ts/presenter/syncmenu.ts
index 7afe0eae..ac62501b 100644
--- a/src/ts/presenter/syncmenu.ts
+++ b/src/ts/presenter/syncmenu.ts
@@ -1,4 +1,5 @@
import type { SyncMode } from "../shared/types";
+import { menuClosed, menuOpened } from "./menus";
import { state } from "./state";
import { applySyncMode } from "./websocket";
@@ -59,6 +60,7 @@ function openMenu(): void {
btnSync.setAttribute("aria-expanded", "true");
document.addEventListener("click", onDocClick);
document.addEventListener("keydown", onKeydown);
+ menuOpened(closeMenu);
}
function closeMenu(): void {
@@ -67,6 +69,7 @@ function closeMenu(): void {
btnSync.setAttribute("aria-expanded", "false");
document.removeEventListener("click", onDocClick);
document.removeEventListener("keydown", onKeydown);
+ menuClosed(closeMenu);
}
function toggleMenu(): void {
diff --git a/src/ts/presenter/transitions.test.ts b/src/ts/presenter/transitions.test.ts
index fd4bfa53..348fe714 100644
--- a/src/ts/presenter/transitions.test.ts
+++ b/src/ts/presenter/transitions.test.ts
@@ -42,7 +42,13 @@ beforeAll(async () => {
beforeEach(() => {
state.slides = [
- { id: "a", svg: "", title: "S1", notes: "" },
+ {
+ id: "a",
+ svg: "",
+ title: "S1",
+ notes: "",
+ editableFiles: [],
+ },
];
state.slideIndex = 0;
state.step = 0;
@@ -61,12 +67,14 @@ describe("reverse", () => {
svg: "",
title: "S1",
notes: "",
+ editableFiles: [],
},
{
id: "b",
svg: "",
title: "S2",
notes: "",
+ editableFiles: [],
},
];
state.slideIndex = 1;
@@ -110,12 +118,14 @@ describe("reverse", () => {
svg: "",
title: "A",
notes: "",
+ editableFiles: [],
},
{
id: "b",
svg: ``,
title: "B",
notes: "",
+ editableFiles: [],
},
];
state.transitions = [
@@ -154,12 +164,14 @@ describe("reverse", () => {
svg: "",
title: "A",
notes: "",
+ editableFiles: [],
},
{
id: "b",
svg: "",
title: "B",
notes: "",
+ editableFiles: [],
},
];
state.transitions = [
@@ -201,12 +213,14 @@ describe("reverse", () => {
svg: "",
title: "A",
notes: "",
+ editableFiles: [],
},
{
id: "b",
svg: "",
title: "B",
notes: "",
+ editableFiles: [],
},
];
state.transitions = [
@@ -244,12 +258,14 @@ describe("snap in-flight", () => {
svg: "",
title: "A",
notes: "",
+ editableFiles: [],
},
{
id: "b",
svg: "",
title: "B",
notes: "",
+ editableFiles: [],
},
];
});
diff --git a/src/ts/presenter/websocket.ts b/src/ts/presenter/websocket.ts
index 24269ac8..56a818f7 100644
--- a/src/ts/presenter/websocket.ts
+++ b/src/ts/presenter/websocket.ts
@@ -5,6 +5,7 @@ import type {
TransitionData,
WsMessage,
} from "../shared/types";
+import { showEditError } from "./edit";
import { renderPv, renderPvNext, updatePvInfo } from "./pv";
import { state } from "./state";
import {
@@ -209,6 +210,8 @@ export function connectWS(wsPort: number | null, authoritative: boolean): void {
renderPv();
} else if (msg.type === "error") {
showError(msg.message);
+ } else if (msg.type === "edit-error") {
+ showEditError(msg.message);
} else if (msg.type === "position") {
// Discard exactly the stale connect-time push so an authoritative window
// keeps its own position; later updates apply normally. Mirrors the
diff --git a/src/ts/presenter/windowsync.test.ts b/src/ts/presenter/windowsync.test.ts
index 2ce194bc..e1ae46d2 100644
--- a/src/ts/presenter/windowsync.test.ts
+++ b/src/ts/presenter/windowsync.test.ts
@@ -37,6 +37,11 @@ beforeAll(async () => {
+
+
+
+
+
`;
({ isSyncPayload } = await import("./windowsync"));
});
diff --git a/src/ts/shared/types.ts b/src/ts/shared/types.ts
index 92102d65..d669fa16 100644
--- a/src/ts/shared/types.ts
+++ b/src/ts/shared/types.ts
@@ -1,11 +1,25 @@
// Every field is always emitted by the Python side (pipeline.py process_deck),
// so all are required here. Consumers that still guard with `|| ""` are being
// defensive, not handling a real absent case.
+export interface EditableFile {
+ label: string;
+ name: string;
+ path: string;
+}
+
export interface SlideData {
id: string;
svg: string;
title: string;
notes: string;
+ editableFiles: EditableFile[];
+}
+
+// Whether the server has a configured edit command for each file kind (env vars
+// INKFLOW_EDIT_CMD_SVG / INKFLOW_EDIT_CMD_MD), baked in at page load — see edit.ts.
+export interface EditCommandsConfig {
+ default: boolean;
+ svg: boolean;
}
// Per-client position-sync mode. Never sent to the server: it only decides,
@@ -56,4 +70,5 @@ export type WsMessage =
logs: LogEntry[];
}
| { type: "error"; message: string }
+ | { type: "edit-error"; message: string }
| ({ type: "position" } & SyncPosition);
diff --git a/tests/decks/edit_button.py b/tests/decks/edit_button.py
new file mode 100644
index 00000000..4456a477
--- /dev/null
+++ b/tests/decks/edit_button.py
@@ -0,0 +1,56 @@
+"""Feature-test deck for the presenter's Edit button.
+
+Serve it with ``uv run inkflow serve tests/decks/edit_button.py`` and click the
+Edit button (opens a dropdown on every slide, in the status bar) on each slide.
+Every dropdown ends with a **Deck** entry (this file) — ``pipeline._editable_files``
+always appends the deck script, so no slide ever has just one editable file:
+
+1. **SVG only** — no markdown, no notes. Two-item dropdown: Layout, Deck.
+2. **Content file** — ``md=`` points at a real file. Three-item dropdown:
+ Layout, Content, Deck.
+3. **Content and notes files** — both ``md=`` and ``notes=`` are file-backed.
+ Four-item dropdown: Layout, Content, Notes, Deck.
+4. **Layout with a parent chain** — ``layouts/edit-parent-child.svg`` has
+ ``inkflow:parent="edit-parent-base"``, which itself has
+ ``inkflow:parent="edit-parent-grandparent"``: two project-local ancestors.
+ Four-item dropdown, root ancestor first so the immediate parent sits next
+ to the layout it belongs to: Parent (edit-parent-grandparent.svg), Parent
+ (edit-parent-base.svg), Layout (edit-parent-child.svg), Deck — the two
+ Parent rows told apart by filename since the label repeats. A built-in/theme
+ ancestor is never offered this way (see
+ ``TestEditableFiles.test_theme_ancestor_excluded`` in test_pipeline.py).
+
+With no ``INKFLOW_EDIT_CMD``/``INKFLOW_EDIT_CMD_SVG`` set, every row copies its
+absolute path to the clipboard; with ``INKFLOW_EDIT_CMD`` set (e.g.
+``INKFLOW_EDIT_CMD="code -r {path}"``), every row launches that command
+instead, unless ``INKFLOW_EDIT_CMD_SVG`` overrides it for the Layout/Parent
+rows specifically. Either way a confirmation toast appears bottom-right.
+
+Also built (not served) by ``tests/test_decks.py`` as a compilation smoke test.
+"""
+
+from inkflow import Deck, Slide
+
+
+def main() -> Deck:
+ return Deck(
+ slides=[
+ Slide(
+ "builtin:title",
+ id="svg-only",
+ zones={"title": "SVG only: Edit acts directly, no dropdown"},
+ ),
+ Slide("builtin:content", id="content-file", md="edit-content"),
+ Slide(
+ "builtin:content",
+ id="content-and-notes",
+ md="edit-content-and-notes",
+ notes="slides/edit-notes.md",
+ ),
+ Slide(
+ "layouts/edit-parent-child",
+ id="layout-with-parent",
+ zones={"title": "This layout has a parent: Layout + Parent"},
+ ),
+ ],
+ )
diff --git a/tests/decks/layouts/edit-parent-base.svg b/tests/decks/layouts/edit-parent-base.svg
new file mode 100644
index 00000000..e85e430e
--- /dev/null
+++ b/tests/decks/layouts/edit-parent-base.svg
@@ -0,0 +1,2 @@
+
diff --git a/tests/decks/layouts/edit-parent-child.svg b/tests/decks/layouts/edit-parent-child.svg
new file mode 100644
index 00000000..2a24d199
--- /dev/null
+++ b/tests/decks/layouts/edit-parent-child.svg
@@ -0,0 +1,3 @@
+
diff --git a/tests/decks/layouts/edit-parent-grandparent.svg b/tests/decks/layouts/edit-parent-grandparent.svg
new file mode 100644
index 00000000..54a43753
--- /dev/null
+++ b/tests/decks/layouts/edit-parent-grandparent.svg
@@ -0,0 +1,3 @@
+
diff --git a/tests/decks/slides/edit-content-and-notes.md b/tests/decks/slides/edit-content-and-notes.md
new file mode 100644
index 00000000..c16222e4
--- /dev/null
+++ b/tests/decks/slides/edit-content-and-notes.md
@@ -0,0 +1,7 @@
+# Edit: content and notes
+
+This slide has both a file-backed `md=` content file and a file-backed
+`notes=` file.
+
+Clicking Edit should offer three entries: **Layout**, **Content** (this
+file), and **Notes** (`slides/edit-notes.md`).
diff --git a/tests/decks/slides/edit-content.md b/tests/decks/slides/edit-content.md
new file mode 100644
index 00000000..d1a67036
--- /dev/null
+++ b/tests/decks/slides/edit-content.md
@@ -0,0 +1,6 @@
+# Edit: content file
+
+This slide's content comes from `slides/edit-content.md`.
+
+Clicking Edit should offer two entries: **Layout** (the SVG) and **Content**
+(this file).
diff --git a/tests/decks/slides/edit-notes.md b/tests/decks/slides/edit-notes.md
new file mode 100644
index 00000000..0a1aefec
--- /dev/null
+++ b/tests/decks/slides/edit-notes.md
@@ -0,0 +1,2 @@
+Speaker notes for the "content and notes" slide, living in their own file.
+Open the presenter panel (`p`) to see this rendered in the Notes pane.
diff --git a/tests/test_edit.py b/tests/test_edit.py
new file mode 100644
index 00000000..fa19ea94
--- /dev/null
+++ b/tests/test_edit.py
@@ -0,0 +1,110 @@
+from __future__ import annotations
+
+import logging
+import subprocess
+from pathlib import Path
+from unittest.mock import MagicMock
+
+import pytest
+
+from inkflow.edit import (
+ EditCommands,
+ command_for,
+ open_in_editor,
+ resolve_edit_commands,
+)
+from inkflow.logging import collect_logs
+
+_ENV_VARS = ("INKFLOW_EDIT_CMD", "INKFLOW_EDIT_CMD_SVG")
+
+
+@pytest.fixture(autouse=True)
+def _isolated_env(monkeypatch: pytest.MonkeyPatch): # pyright: ignore[reportUnusedFunction]
+ for name in _ENV_VARS:
+ monkeypatch.delenv(name, raising=False)
+ yield
+
+
+# ── resolve_edit_commands ────────────────────────────────────────────────────
+
+
+def test_resolve_edit_commands_unset() -> None:
+ assert resolve_edit_commands() == EditCommands(default=None, svg=None)
+
+
+def test_resolve_edit_commands_from_env(monkeypatch: pytest.MonkeyPatch) -> None:
+ monkeypatch.setenv("INKFLOW_EDIT_CMD", "nvim {path}")
+ monkeypatch.setenv("INKFLOW_EDIT_CMD_SVG", "code -r {path}")
+ assert resolve_edit_commands() == EditCommands(
+ default="nvim {path}", svg="code -r {path}"
+ )
+
+
+# ── command_for ───────────────────────────────────────────────────────────────
+
+
+def test_command_for_svg_suffix_uses_svg_override() -> None:
+ commands = EditCommands(default="edit-default", svg="edit-svg")
+ assert command_for(Path("slide.svg"), commands) == "edit-svg"
+
+
+def test_command_for_svg_suffix_case_insensitive() -> None:
+ commands = EditCommands(default="edit-default", svg="edit-svg")
+ assert command_for(Path("slide.SVG"), commands) == "edit-svg"
+
+
+def test_command_for_other_suffix_uses_default() -> None:
+ commands = EditCommands(default="edit-default", svg="edit-svg")
+ assert command_for(Path("notes.md"), commands) == "edit-default"
+
+
+def test_command_for_svg_falls_back_to_default_without_override() -> None:
+ # The general command also applies to SVG files when no SVG-specific
+ # override is set — setting only INKFLOW_EDIT_CMD covers everything.
+ commands = EditCommands(default="edit-default", svg=None)
+ assert command_for(Path("slide.svg"), commands) == "edit-default"
+
+
+def test_command_for_none_configured() -> None:
+ commands = EditCommands(default=None, svg=None)
+ assert command_for(Path("slide.svg"), commands) is None
+
+
+# ── open_in_editor ────────────────────────────────────────────────────────────
+
+
+def test_open_in_editor_substitutes_placeholder(
+ monkeypatch: pytest.MonkeyPatch,
+) -> None:
+ popen = MagicMock()
+ monkeypatch.setattr(subprocess, "Popen", popen)
+ path = Path("/tmp/slide.svg")
+ result = open_in_editor(path, "code -r --goto {path}")
+ args = popen.call_args[0][0] # pyright: ignore[reportAny]
+ assert args == ["code", "-r", "--goto", str(path)]
+ assert result is None
+
+
+def test_open_in_editor_appends_path_when_no_placeholder(
+ monkeypatch: pytest.MonkeyPatch,
+) -> None:
+ popen = MagicMock()
+ monkeypatch.setattr(subprocess, "Popen", popen)
+ path = Path("/tmp/notes.md")
+ open_in_editor(path, "nvim")
+ args = popen.call_args[0][0] # pyright: ignore[reportAny]
+ assert args == ["nvim", str(path)]
+
+
+def test_open_in_editor_launch_failure_warns_and_returns_message(
+ monkeypatch: pytest.MonkeyPatch,
+) -> None:
+ def _raise(*_args: object, **_kwargs: object) -> None:
+ raise OSError("no such file or directory")
+
+ monkeypatch.setattr(subprocess, "Popen", _raise)
+ with collect_logs(logging.WARNING) as warnings:
+ result = open_in_editor(Path("/tmp/slide.svg"), "not-a-real-editor {path}")
+ assert any("failed to launch edit command" in w.message for w in warnings)
+ assert result is not None
+ assert "failed to launch edit command" in result
diff --git a/tests/test_fonts.py b/tests/test_fonts.py
index 7e5a9057..5814d8b4 100644
--- a/tests/test_fonts.py
+++ b/tests/test_fonts.py
@@ -32,7 +32,7 @@
def _slide(svg: str) -> SlideData:
- return {"svg": svg, "title": "", "id": "", "notes": ""}
+ return {"svg": svg, "title": "", "id": "", "notes": "", "editableFiles": []}
def _svg(body: str) -> str:
diff --git a/tests/test_pipeline.py b/tests/test_pipeline.py
index a82f77d8..12d61168 100644
--- a/tests/test_pipeline.py
+++ b/tests/test_pipeline.py
@@ -455,7 +455,7 @@ def _write_slide(self, tmp_path: Path, name: str, content: str) -> Path:
def test_foreignobject_replaces_zone_rect(self, tmp_path: Path) -> None:
self._write_slide(tmp_path, "slide.svg", _ZONE_SLIDE_SVG)
deck = Deck(slides=[Slide("slides/slide.svg", zones={"content": "hello"})])
- results = process_deck(deck, tmp_path)
+ results = process_deck(deck, tmp_path, tmp_path / "deck.py")
assert len(results) == 1
assert "foreignObject" in results[0]["svg"]
assert "hello" in results[0]["svg"]
@@ -463,14 +463,14 @@ def test_foreignobject_replaces_zone_rect(self, tmp_path: Path) -> None:
def test_zone_rect_id_inherited_by_foreignobject(self, tmp_path: Path) -> None:
self._write_slide(tmp_path, "slide.svg", _ZONE_SLIDE_SVG)
deck = Deck(slides=[Slide("slides/slide.svg", zones={"content": "hi"})])
- results = process_deck(deck, tmp_path)
+ results = process_deck(deck, tmp_path, tmp_path / "deck.py")
assert 'id="zone-content"' in results[0]["svg"]
def test_unreferenced_zone_rects_removed(self, tmp_path: Path) -> None:
self._write_slide(tmp_path, "slide.svg", _LAYOUT_SVG)
# Only supply content for zone-content, leave zone-title unconsumed
deck = Deck(slides=[Slide("slides/slide.svg", zones={"content": "body"})])
- results = process_deck(deck, tmp_path)
+ results = process_deck(deck, tmp_path, tmp_path / "deck.py")
assert 'id="zone-title"' not in results[0]["svg"]
def test_foreignobject_content_has_inkflow_content_class(
@@ -478,7 +478,7 @@ def test_foreignobject_content_has_inkflow_content_class(
) -> None:
self._write_slide(tmp_path, "slide.svg", _ZONE_SLIDE_SVG)
deck = Deck(slides=[Slide("slides/slide.svg", zones={"content": "x"})])
- results = process_deck(deck, tmp_path)
+ results = process_deck(deck, tmp_path, tmp_path / "deck.py")
assert "inkflow-content" in results[0]["svg"]
@@ -496,7 +496,7 @@ def test_markdown_slide_expands_to_foreignobject(self, tmp_path: Path) -> None:
md = slides_dir / "content.md"
md.write_text("# Hello\n\nBody text here.\n", encoding="utf-8")
deck = Deck(slides=[Slide("layout", md="content")])
- results = process_deck(deck, tmp_path)
+ results = process_deck(deck, tmp_path, tmp_path / "deck.py")
assert len(results) == 1
assert "foreignObject" in results[0]["svg"]
assert "Body text" in results[0]["svg"]
@@ -506,7 +506,7 @@ def test_markdown_slide_title_extracted(self, tmp_path: Path) -> None:
md = slides_dir / "content.md"
md.write_text("# My Title\n\nSome content.\n", encoding="utf-8")
deck = Deck(slides=[Slide("layout", md="content")])
- results = process_deck(deck, tmp_path)
+ results = process_deck(deck, tmp_path, tmp_path / "deck.py")
assert results[0]["title"] == "My Title"
def test_markdown_slide_animations_applied(self, tmp_path: Path) -> None:
@@ -515,7 +515,7 @@ def test_markdown_slide_animations_applied(self, tmp_path: Path) -> None:
deck = Deck(
slides=[Slide("layout", md="content", animations=[FadeIn("zone-title")])]
)
- results = process_deck(deck, tmp_path)
+ results = process_deck(deck, tmp_path, tmp_path / "deck.py")
cues = self._title_cues(results[0]["svg"])
assert [c["name"] for c in cues] == ["fade-in"]
@@ -526,7 +526,7 @@ def _title_cues(svg: str) -> list[_CueDict]:
def test_zones_media_injected(self, tmp_path: Path) -> None:
self._setup(tmp_path)
deck = Deck(slides=[Slide("layout", zones={"content": Image("photo.jpg")})])
- results = process_deck(deck, tmp_path)
+ results = process_deck(deck, tmp_path, tmp_path / "deck.py")
assert "photo.jpg" in results[0]["svg"]
def test_deck_animations_concatenate_after_reveals(self, tmp_path: Path) -> None:
@@ -538,7 +538,7 @@ def test_deck_animations_concatenate_after_reveals(self, tmp_path: Path) -> None
deck = Deck(
slides=[Slide("layout", md="content", animations=[FadeIn("zone-title")])]
)
- svg = process_deck(deck, tmp_path)[0]["svg"]
+ svg = process_deck(deck, tmp_path, tmp_path / "deck.py")[0]["svg"]
root = parse_svg(svg)
reveal = next(
el for el in root.iter() if (el.get("id") or "").startswith("inkflow-step-")
@@ -561,7 +561,7 @@ def test_autoplay_overridden_by_play_video_cue(self, tmp_path: Path) -> None:
]
)
with collect_logs(logging.WARNING) as warnings:
- svg = process_deck(deck, tmp_path)[0]["svg"]
+ svg = process_deck(deck, tmp_path, tmp_path / "deck.py")[0]["svg"]
assert any("autoplay overridden" in w.message for w in warnings)
assert "data-autoplay" not in svg # the cue wins, autoplay stripped
assert not re.search(r"]*\bmuted\b", svg) # Muted.AUTO -> audible
@@ -570,7 +570,7 @@ def test_autoplay_overridden_by_play_video_cue(self, tmp_path: Path) -> None:
def test_zones_inline_markdown_injected(self, tmp_path: Path) -> None:
self._setup(tmp_path)
deck = Deck(slides=[Slide("layout", zones={"content": "**bold text**"})])
- results = process_deck(deck, tmp_path)
+ results = process_deck(deck, tmp_path, tmp_path / "deck.py")
assert "bold" in results[0]["svg"]
@@ -610,7 +610,7 @@ def test_layout_class_in_processed_slide(self, tmp_path: Path) -> None:
(layouts_dir / "mylayout.svg").write_text(_ZONE_SLIDE_SVG, encoding="utf-8")
(tmp_path / "slides").mkdir()
deck = Deck(slides=[Slide("mylayout", zones={"content": "hi"})])
- results = process_deck(deck, tmp_path)
+ results = process_deck(deck, tmp_path, tmp_path / "deck.py")
assert "layout-mylayout" in results[0]["svg"]
def test_scope_wraps_injected_deck_style(self, tmp_path: Path) -> None:
@@ -620,7 +620,7 @@ def test_scope_wraps_injected_deck_style(self, tmp_path: Path) -> None:
deck = Deck(
style=Inline("#box { fill: red; }"), slides=[Slide("slides/plain.svg")]
)
- results = process_deck(deck, tmp_path)
+ results = process_deck(deck, tmp_path, tmp_path / "deck.py")
assert "@scope" in results[0]["svg"]
def test_no_scope_without_inline_styles(self, tmp_path: Path) -> None:
@@ -628,7 +628,7 @@ def test_no_scope_without_inline_styles(self, tmp_path: Path) -> None:
slide = tmp_path / "slides" / "plain.svg"
slide.write_text(_PLAIN_SVG, encoding="utf-8")
deck = Deck(slides=[Slide("slides/plain.svg")])
- results = process_deck(deck, tmp_path)
+ results = process_deck(deck, tmp_path, tmp_path / "deck.py")
assert "@scope" not in results[0]["svg"]
@@ -668,7 +668,7 @@ def test_process_deck_includes_id(self, tmp_path: Path) -> None:
slide = tmp_path / "slides" / "plain.svg"
slide.write_text(_PLAIN_SVG, encoding="utf-8")
deck = Deck(slides=[Slide("slides/plain.svg")])
- results = process_deck(deck, tmp_path)
+ results = process_deck(deck, tmp_path, tmp_path / "deck.py")
assert results[0]["id"] == "plain"
def test_process_deck_id_collision_resolved(self, tmp_path: Path) -> None:
@@ -681,11 +681,142 @@ def test_process_deck_id_collision_resolved(self, tmp_path: Path) -> None:
Slide("slides/plain2.svg", id="plain"),
]
)
- results = process_deck(deck, tmp_path)
+ results = process_deck(deck, tmp_path, tmp_path / "deck.py")
assert results[0]["id"] == "plain"
assert results[1]["id"] == "plain-2"
+def _svg_with_parent(parent: str) -> str:
+ return (
+ '\n"
+ )
+
+
+class TestEditableFiles:
+ def test_svg_only_slide_has_layout_and_deck_entries(self, tmp_path: Path) -> None:
+ # deck_path is always appended, so even the plainest slide never has just
+ # one editable file — Layout + Deck is the floor.
+ (tmp_path / "slides").mkdir()
+ slide_path = tmp_path / "slides" / "plain.svg"
+ slide_path.write_text(_PLAIN_SVG, encoding="utf-8")
+ deck_path = tmp_path / "my_deck.py"
+ deck = Deck(slides=[Slide("slides/plain.svg")])
+ results = process_deck(deck, tmp_path, deck_path)
+ assert results[0]["editableFiles"] == [
+ {"label": "Layout", "name": "plain.svg", "path": str(slide_path)},
+ {"label": "Deck", "name": "my_deck.py", "path": str(deck_path)},
+ ]
+
+ def test_file_backed_md_adds_content_entry(self, tmp_path: Path) -> None:
+ layout = tmp_path / "layouts" / "layout.svg"
+ layout.parent.mkdir(parents=True, exist_ok=True)
+ layout.write_text(_LAYOUT_SVG, encoding="utf-8")
+ slides_dir = tmp_path / "slides"
+ slides_dir.mkdir()
+ md_path = slides_dir / "content.md"
+ md_path.write_text("# Hello\n", encoding="utf-8")
+ deck_path = tmp_path / "deck.py"
+ deck = Deck(slides=[Slide("layout", md="content")])
+ results = process_deck(deck, tmp_path, deck_path)
+ assert results[0]["editableFiles"] == [
+ {"label": "Layout", "name": "layout.svg", "path": str(layout)},
+ {"label": "Content", "name": "content.md", "path": str(md_path)},
+ {"label": "Deck", "name": "deck.py", "path": str(deck_path)},
+ ]
+
+ def test_inline_md_has_no_content_entry(self, tmp_path: Path) -> None:
+ layout = tmp_path / "layouts" / "layout.svg"
+ layout.parent.mkdir(parents=True, exist_ok=True)
+ layout.write_text(_LAYOUT_SVG, encoding="utf-8")
+ deck_path = tmp_path / "deck.py"
+ deck = Deck(slides=[Slide("layout", md=Inline("# Hello"))])
+ results = process_deck(deck, tmp_path, deck_path)
+ assert results[0]["editableFiles"] == [
+ {"label": "Layout", "name": "layout.svg", "path": str(layout)},
+ {"label": "Deck", "name": "deck.py", "path": str(deck_path)},
+ ]
+
+ def test_file_backed_notes_adds_notes_entry(self, tmp_path: Path) -> None:
+ (tmp_path / "slides").mkdir()
+ slide_path = tmp_path / "slides" / "plain.svg"
+ slide_path.write_text(_PLAIN_SVG, encoding="utf-8")
+ notes_path = tmp_path / "slides" / "plain-notes.md"
+ notes_path.write_text("Speak slowly.", encoding="utf-8")
+ deck_path = tmp_path / "deck.py"
+ deck = Deck(slides=[Slide("slides/plain.svg", notes="slides/plain-notes.md")])
+ results = process_deck(deck, tmp_path, deck_path)
+ assert results[0]["editableFiles"] == [
+ {"label": "Layout", "name": "plain.svg", "path": str(slide_path)},
+ {"label": "Notes", "name": "plain-notes.md", "path": str(notes_path)},
+ {"label": "Deck", "name": "deck.py", "path": str(deck_path)},
+ ]
+
+ def test_all_editable_files_in_order(self, tmp_path: Path) -> None:
+ parent = tmp_path / "layouts" / "parent.svg"
+ parent.parent.mkdir(parents=True, exist_ok=True)
+ parent.write_text(_LAYOUT_SVG, encoding="utf-8")
+ layout = tmp_path / "layouts" / "layout.svg"
+ layout.write_text(_svg_with_parent("parent"), encoding="utf-8")
+ slides_dir = tmp_path / "slides"
+ slides_dir.mkdir()
+ md_path = slides_dir / "content.md"
+ md_path.write_text("# Hello\n", encoding="utf-8")
+ notes_path = slides_dir / "content-notes.md"
+ notes_path.write_text("Notes.", encoding="utf-8")
+ deck_path = tmp_path / "deck.py"
+ deck = Deck(
+ slides=[Slide("layout", md="content", notes="slides/content-notes.md")]
+ )
+ results = process_deck(deck, tmp_path, deck_path)
+ assert results[0]["editableFiles"] == [
+ {"label": "Parent", "name": "parent.svg", "path": str(parent)},
+ {"label": "Layout", "name": "layout.svg", "path": str(layout)},
+ {"label": "Content", "name": "content.md", "path": str(md_path)},
+ {"label": "Notes", "name": "content-notes.md", "path": str(notes_path)},
+ {"label": "Deck", "name": "deck.py", "path": str(deck_path)},
+ ]
+
+ def test_ancestor_chain_listed_root_first_next_to_layout(
+ self, tmp_path: Path
+ ) -> None:
+ # Root-first, so the immediate parent sits right next to Layout: reading
+ # top to bottom is root -> ... -> immediate parent -> layout -> content.
+ grandparent = tmp_path / "layouts" / "grandparent.svg"
+ grandparent.parent.mkdir(parents=True, exist_ok=True)
+ grandparent.write_text(_LAYOUT_SVG, encoding="utf-8")
+ parent = tmp_path / "layouts" / "parent.svg"
+ parent.write_text(_svg_with_parent("grandparent"), encoding="utf-8")
+ layout = tmp_path / "layouts" / "layout.svg"
+ layout.write_text(_svg_with_parent("parent"), encoding="utf-8")
+ deck_path = tmp_path / "deck.py"
+ deck = Deck(slides=[Slide("layout")])
+ results = process_deck(deck, tmp_path, deck_path)
+ assert results[0]["editableFiles"] == [
+ {"label": "Parent", "name": "grandparent.svg", "path": str(grandparent)},
+ {"label": "Parent", "name": "parent.svg", "path": str(parent)},
+ {"label": "Layout", "name": "layout.svg", "path": str(layout)},
+ {"label": "Deck", "name": "deck.py", "path": str(deck_path)},
+ ]
+
+ def test_theme_ancestor_excluded(self, tmp_path: Path) -> None:
+ # A layout built on a built-in/theme ancestor: that ancestor lives outside
+ # the project (often inside an installed package), so it's not offered.
+ layout = tmp_path / "layouts" / "layout.svg"
+ layout.parent.mkdir(parents=True, exist_ok=True)
+ layout.write_text(_svg_with_parent("builtin:base"), encoding="utf-8")
+ deck_path = tmp_path / "deck.py"
+ deck = Deck(slides=[Slide("layout")])
+ results = process_deck(deck, tmp_path, deck_path)
+ assert results[0]["editableFiles"] == [
+ {"label": "Layout", "name": "layout.svg", "path": str(layout)},
+ {"label": "Deck", "name": "deck.py", "path": str(deck_path)},
+ ]
+
+
class TestParseMarkdownOnce:
def test_markdown_parsed_once_per_md_slide(
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
@@ -709,7 +840,7 @@ def counting(text: str) -> object:
Slide("slides/b.svg", md=Inline("# B\n\nbody")),
]
)
- process_deck(deck, tmp_path)
+ process_deck(deck, tmp_path, tmp_path / "deck.py")
# once per md slide
assert len(calls) == 2
@@ -773,7 +904,7 @@ def _project(self, tmp_path: Path) -> Path:
return tmp_path
def _svg_for(self, tmp_path: Path, deck: Deck) -> str:
- return process_deck(deck, tmp_path)[0]["svg"]
+ return process_deck(deck, tmp_path, tmp_path / "deck.py")[0]["svg"]
def test_deck_overlays_apply(self, tmp_path: Path) -> None:
self._project(tmp_path)
diff --git a/tests/test_server.py b/tests/test_server.py
index a026332d..e088928b 100644
--- a/tests/test_server.py
+++ b/tests/test_server.py
@@ -8,11 +8,14 @@
import pytest
from inkflow.assets import AssetRoots
+from inkflow.edit import EditCommands
from inkflow.enums import ColorMode
+from inkflow.pipeline import EditableFile, SlideData
from inkflow.server import (
State,
_coerce_nav_position, # pyright: ignore[reportPrivateUsage]
_resolve_asset, # pyright: ignore[reportPrivateUsage]
+ _resolve_edit_request, # pyright: ignore[reportPrivateUsage]
build_html,
)
@@ -44,6 +47,7 @@ def _state(**overrides: object) -> State:
"__DATA_THEME__",
"__SLIDES_JSON__",
"__WS_PORT__",
+ "__EDIT_COMMANDS_JSON__",
"__ERROR_JSON__",
"__TRANSITIONS_JSON__",
"__LOGS_JSON__",
@@ -112,6 +116,20 @@ def test_build_html_transitions_json_embedded() -> None:
assert json.dumps([{"type": "fade"}]) in html
+def test_build_html_edit_commands_default_both_false() -> None:
+ html = build_html(_state(), ws_port=7778).decode()
+ assert json.dumps({"default": False, "svg": False}) in html
+
+
+def test_build_html_edit_commands_reflects_configured() -> None:
+ html = build_html(
+ _state(),
+ ws_port=7778,
+ edit_commands=EditCommands(svg="code {path}", default=None),
+ ).decode()
+ assert json.dumps({"default": False, "svg": True}) in html
+
+
def test_build_html_logs_json_embedded() -> None:
logs = [
{"level": "warning", "message": 'font "Inter" not found in any font directory'}
@@ -224,3 +242,59 @@ def test_coerce_nav_empty_deck_pins_index_to_zero() -> None:
def test_coerce_nav_defaults_when_fields_absent() -> None:
assert _coerce_nav_position({}, 5) == {"slideIndex": 0, "step": 0}
+
+
+# ── _resolve_edit_request ──────────────────────────────────────────────────────
+
+
+def _slide_with_files(*files: EditableFile) -> SlideData:
+ return {
+ "id": "s",
+ "svg": "",
+ "title": "",
+ "notes": "",
+ "editableFiles": list(files),
+ }
+
+
+def test_resolve_edit_request_valid_path_and_configured_command() -> None:
+ slides = [
+ _slide_with_files(
+ {"label": "Layout", "name": "slide.svg", "path": "/deck/slide.svg"}
+ )
+ ]
+ commands = EditCommands(svg="code -r {path}", default=None)
+ assert _resolve_edit_request({"path": "/deck/slide.svg"}, slides, commands) == (
+ Path("/deck/slide.svg"),
+ "code -r {path}",
+ )
+
+
+def test_resolve_edit_request_unknown_path_dropped() -> None:
+ slides = [
+ _slide_with_files(
+ {"label": "Layout", "name": "slide.svg", "path": "/deck/slide.svg"}
+ )
+ ]
+ commands = EditCommands(svg="code -r {path}", default=None)
+ assert _resolve_edit_request({"path": "/etc/passwd"}, slides, commands) is None
+
+
+def test_resolve_edit_request_missing_path_field_dropped() -> None:
+ slides = [
+ _slide_with_files(
+ {"label": "Layout", "name": "slide.svg", "path": "/deck/slide.svg"}
+ )
+ ]
+ commands = EditCommands(svg="code -r {path}", default=None)
+ assert _resolve_edit_request({}, slides, commands) is None
+
+
+def test_resolve_edit_request_no_command_configured_dropped() -> None:
+ slides = [
+ _slide_with_files(
+ {"label": "Layout", "name": "slide.svg", "path": "/deck/slide.svg"}
+ )
+ ]
+ commands = EditCommands(svg=None, default=None)
+ assert _resolve_edit_request({"path": "/deck/slide.svg"}, slides, commands) is None
KEYBINDINGS
+
+ `;
+ vi.resetModules();
+ ({ initEditMenu, renderEditButton, showEditError } = await import(
+ "./edit"
+ ));
+ ({ menuOpened } = await import("./menus"));
+ ({ state } = await import("./state"));
+ btnEdit = document.getElementById("btn-edit") as HTMLButtonElement;
+ editMenu = document.getElementById("edit-menu")!;
+ editWrap = btnEdit.closest(".edit-wrap") as HTMLElement;
+ editToast = document.getElementById("edit-toast")!;
+ editToastText = document.getElementById("edit-toast-text")!;
+ editToastClose = document.getElementById(
+ "edit-toast-close",
+ ) as HTMLButtonElement;
+ state.slides = [];
+ state.slideIndex = 0;
+ state.ws = null;
+ vi.stubGlobal("navigator", {
+ clipboard: { writeText: vi.fn().mockResolvedValue(undefined) },
+ });
+});
+
+afterEach(() => {
+ vi.unstubAllGlobals();
+});
+
+function slideWith(
+ ...editableFiles: { label: string; name: string; path: string }[]
+) {
+ return { id: "s", svg: "", title: "", notes: "", editableFiles };
+}
+
+test("hides the wrap entirely when there is no WS port (static export)", () => {
+ initEditMenu({ svg: false, default: false }, null);
+ expect(editWrap.style.display).toBe("none");
+});
+
+test("renderEditButton populates one row per editable file, with an icon, label and filename", () => {
+ state.slides = [
+ slideWith(
+ { label: "Layout", name: "slide.svg", path: "/deck/slide.svg" },
+ { label: "Content", name: "slide.md", path: "/deck/slide.md" },
+ ),
+ ];
+ renderEditButton();
+ const rows = editMenu.querySelectorAll(".edit-row");
+ expect(rows.length).toBe(2);
+ expect(rows[0].querySelector("svg")).not.toBeNull();
+ expect(rows[0].querySelector(".edit-row-label")?.textContent).toBe(
+ "Layout",
+ );
+ expect(rows[0].querySelector(".edit-row-name")?.textContent).toBe(
+ "slide.svg",
+ );
+ expect(rows[1].querySelector(".edit-row-label")?.textContent).toBe(
+ "Content",
+ );
+ expect(rows[1].querySelector(".edit-row-name")?.textContent).toBe(
+ "slide.md",
+ );
+});
+
+test("distinct Parent rows still read apart via their filename", () => {
+ state.slides = [
+ slideWith(
+ { label: "Layout", name: "child.svg", path: "/deck/child.svg" },
+ { label: "Parent", name: "parent.svg", path: "/deck/parent.svg" },
+ {
+ label: "Parent",
+ name: "grandparent.svg",
+ path: "/deck/grandparent.svg",
+ },
+ ),
+ ];
+ renderEditButton();
+ const names = Array.from(editMenu.querySelectorAll(".edit-row-name")).map(
+ (n) => n.textContent,
+ );
+ expect(names).toEqual(["child.svg", "parent.svg", "grandparent.svg"]);
+});
+
+test("a single editable file still opens a (one-row) dropdown", () => {
+ // Never happens in production (pipeline._editable_files always appends the
+ // deck script, so the real floor is two entries) but edit.ts makes no
+ // assumption about that — it just renders whatever it's given.
+ state.slides = [
+ slideWith({
+ label: "Layout",
+ name: "slide.svg",
+ path: "/deck/slide.svg",
+ }),
+ ];
+ initEditMenu({ svg: false, default: false }, 7778);
+ btnEdit.click();
+ expect(editMenu.classList.contains("open")).toBe(true);
+ expect(editMenu.querySelectorAll(".edit-row").length).toBe(1);
+});
+
+test("clicking the lone row copies the full path and flashes a confirmation", () => {
+ state.slides = [
+ slideWith({
+ label: "Layout",
+ name: "slide.svg",
+ path: "/deck/slide.svg",
+ }),
+ ];
+ initEditMenu({ svg: false, default: false }, 7778);
+ btnEdit.click();
+ editMenu.querySelector
+
+
+
+
+