@capacms/sdk 1.0.0-next.1 → 1.0.0-next.10

package/dist/nextjs/overlay.d.ts

@@ -0,0 +1,30 @@
+export interface CapaOverlayProps {
+    /** The Capa admin origins allowed to drive the overlay. */
+    adminOrigins: string[];
+    /**
+     * How a save shows. `"in-place"` (the default) re-renders the draft with
+     * `router.refresh()`, and reloads the page only if that has not landed
+     * within `refreshTimeoutMs`. `"reload"` reloads the page on every save.
+     * The scroll position is kept either way.
+     */
+    refresh?: "in-place" | "reload";
+    /** How long an in-place refresh may take before the page reloads instead. 10 seconds. */
+    refreshTimeoutMs?: number;
+}
+/**
+ * The refresh runs in a transition, so `isPending` says when the new draft
+ * has been committed to the screen, and the overlay settles the refresh
+ * then: it puts the scroll position back, and a refresh that has not
+ * committed within `refreshTimeoutMs` reloads.
+ *
+ * While the transition is pending the overlay makes a no-op state update
+ * every `REFRESH_NUDGE_MS`. React 19.2 under Next 15.5 can leave a draft
+ * refresh suspended after every part of its streamed response has arrived:
+ * the page suspends inside an already visible Suspense boundary (a root
+ * `loading.tsx` makes one around every page), and the signal that its data
+ * is ready is lost, so nothing commits until some other state update. Any
+ * state update makes React retry the suspended render, which then completes.
+ * A refresh that commits on its own stops the nudges at once. Draft mode
+ * only: a visitor never runs this component.
+ */
+export declare function CapaOverlay({ adminOrigins, refresh, refreshTimeoutMs }: CapaOverlayProps): null;

package/dist/nextjs/overlay.js

@@ -0,0 +1,78 @@
+"use strict";
+"use client";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CapaOverlay = CapaOverlay;
+/**
+ * `<CapaOverlay />`: Capa's live preview overlay as one Next.js client
+ * component (M6).
+ *
+ *   // app/layout.tsx (a server component)
+ *   import { CapaOverlay } from "@capacms/sdk/nextjs/overlay";
+ *   {edit ? <CapaOverlay adminOrigins={["https://app.capacms.com"]} /> : null}
+ *
+ * Render it only in edit mode (`editMode()` from `@capacms/sdk/nextjs`), so a
+ * visitor never downloads it. Inside the Capa editor it outlines the focused
+ * field, reports clicks back, and on a save re-renders the page with
+ * `router.refresh()`, keeping the scroll position. Outside a Capa frame it does
+ * nothing at all.
+ *
+ * Its own entry point, apart from `@capacms/sdk/nextjs`, because it imports
+ * `react` and `next/navigation` and is a client module: the server helpers must
+ * stay free of both. A bundler that imports it gets an ES module, so it sees
+ * that only `useRouter` is used from `next/navigation` and leaves the chunks a
+ * visitor loads as they were.
+ */
+const react_1 = require("react");
+const navigation_1 = require("next/navigation");
+const index_js_1 = require("../overlay/index.js");
+/**
+ * While a refresh is pending, the overlay updates its own unused state this
+ * often. See `CapaOverlay` for why.
+ */
+const REFRESH_NUDGE_MS = 300;
+/**
+ * The refresh runs in a transition, so `isPending` says when the new draft
+ * has been committed to the screen, and the overlay settles the refresh
+ * then: it puts the scroll position back, and a refresh that has not
+ * committed within `refreshTimeoutMs` reloads.
+ *
+ * While the transition is pending the overlay makes a no-op state update
+ * every `REFRESH_NUDGE_MS`. React 19.2 under Next 15.5 can leave a draft
+ * refresh suspended after every part of its streamed response has arrived:
+ * the page suspends inside an already visible Suspense boundary (a root
+ * `loading.tsx` makes one around every page), and the signal that its data
+ * is ready is lost, so nothing commits until some other state update. Any
+ * state update makes React retry the suspended render, which then completes.
+ * A refresh that commits on its own stops the nudges at once. Draft mode
+ * only: a visitor never runs this component.
+ */
+function CapaOverlay({ adminOrigins, refresh = "in-place", refreshTimeoutMs }) {
+    const router = (0, navigation_1.useRouter)();
+    const [refreshing, startRefresh] = (0, react_1.useTransition)();
+    const [, nudge] = (0, react_1.useState)(0);
+    /** One resolver per refresh waiting for its transition to commit. */
+    const waiting = (0, react_1.useRef)([]);
+    // A string, so a new array with the same origins does not restart it.
+    const origins = adminOrigins.join(",");
+    (0, react_1.useEffect)(() => (0, index_js_1.startOverlay)({
+        adminOrigins: origins.split(",").filter(Boolean),
+        onRefresh: refresh === "reload"
+            ? undefined
+            : () => new Promise((resolve) => {
+                waiting.current.push(resolve);
+                startRefresh(() => router.refresh());
+            }),
+        refreshTimeoutMs,
+    }), [origins, router, refresh, refreshTimeoutMs]);
+    (0, react_1.useEffect)(() => {
+        if (!refreshing) {
+            // Committed: every refresh started before now is on screen.
+            for (const settle of waiting.current.splice(0))
+                settle();
+            return;
+        }
+        const timer = window.setInterval(() => nudge((n) => n + 1), REFRESH_NUDGE_MS);
+        return () => window.clearInterval(timer);
+    }, [refreshing]);
+    return null;
+}

package/dist/overlay/index.d.ts

@@ -1,5 +1,5 @@
-export { acceptMessage, hoverMessage, normaliseOrigins, readyMessage, selectMessage, ADMIN_SOURCE, PROTOCOL_VERSION, SITE_SOURCE, } from "./protocol";
-export type { AdminMessage, MessageLike, SiteMessage } from "./protocol";
+export { acceptMessage, hoverMessage, normaliseOrigins, patchedText, pickCentred, readyMessage, scrollEdge, selectMessage, textAround, visibleMessage, ADMIN_SOURCE, PATCH_MAX_FIELDS, PATCH_MAX_LENGTH, PROTOCOL_VERSION, SITE_FEATURES, SITE_SOURCE, } from "./protocol.js";
+export type { AdminMessage, MessageLike, PatchField, SiteMessage, TaggedBox } from "./protocol.js";
 export interface OverlayOptions {
     /**
      * The Capa admin origins allowed to drive this page, for example
@@ -9,9 +9,21 @@ export interface OverlayOptions {
     /**
      * How to re-render the draft after the editor saves. `router.refresh()` in a
      * Next app. Without it the page reloads. Scroll position is kept either way.
+     *
+     * Return a promise that settles once the new draft is on screen, and the
+     * overlay waits for it: a promise that rejects, or is still pending after
+     * `refreshTimeoutMs`, falls back to a reload, which keeps the scroll
+     * position too. A function that returns nothing counts as done at once.
      */
     onRefresh?: () => void | Promise<void>;
+    /**
+     * How long `onRefresh`'s promise may stay pending before the page reloads
+     * instead. 10 seconds.
+     */
+    refreshTimeoutMs?: number;
 }
+/** How long an in-place refresh may take before the page reloads instead. */
+export declare const REFRESH_TIMEOUT_MS = 10000;
 /**
  * Start the overlay. Returns a disposer that removes every listener and the
  * drawing layer. Calling it again while it runs updates the options and returns

package/dist/overlay/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SITE_SOURCE = exports.PROTOCOL_VERSION = exports.ADMIN_SOURCE = exports.selectMessage = exports.readyMessage = exports.normaliseOrigins = exports.hoverMessage = exports.acceptMessage = void 0;
+exports.REFRESH_TIMEOUT_MS = exports.SITE_SOURCE = exports.SITE_FEATURES = exports.PROTOCOL_VERSION = exports.PATCH_MAX_LENGTH = exports.PATCH_MAX_FIELDS = exports.ADMIN_SOURCE = exports.visibleMessage = exports.textAround = exports.selectMessage = exports.scrollEdge = exports.readyMessage = exports.pickCentred = exports.patchedText = exports.normaliseOrigins = exports.hoverMessage = exports.acceptMessage = void 0;
 exports.startOverlay = startOverlay;
 /**
  * `@capacms/sdk/overlay`: the site half of Capa's live preview.
@@ -9,29 +9,62 @@ exports.startOverlay = startOverlay;
  *   useEffect(() => startOverlay({ adminOrigins: ["https://app.capacms.com"] }), []);
  *
  * Inside the Capa editor's preview frame this outlines the element an editor is
- * working on, reports clicks on tagged elements back to the editor, and
- * re-renders the draft after a save. Outside a frame it does nothing at all:
+ * working on, reports clicks on tagged elements back to the editor, shows the
+ * text being typed in the elements that show it verbatim, and re-renders the
+ * draft after a save. Outside a frame it does nothing at all:
  * no listeners, no DOM, no cost.
  *
+ * A click on a tagged element selects its field. A ⌘-click (Ctrl-click on
+ * Windows and Linux) on a tagged element that is a link, or sits inside one,
+ * follows the link in the frame instead, so an editor can move between pages.
+ *
  * Vanilla DOM and no imports beyond the pure protocol module, so it works in
  * any framework and adds nothing to a bundle that does not call it.
  */
-const protocol_1 = require("./protocol");
-var protocol_2 = require("./protocol");
-Object.defineProperty(exports, "acceptMessage", { enumerable: true, get: function () { return protocol_2.acceptMessage; } });
-Object.defineProperty(exports, "hoverMessage", { enumerable: true, get: function () { return protocol_2.hoverMessage; } });
-Object.defineProperty(exports, "normaliseOrigins", { enumerable: true, get: function () { return protocol_2.normaliseOrigins; } });
-Object.defineProperty(exports, "readyMessage", { enumerable: true, get: function () { return protocol_2.readyMessage; } });
-Object.defineProperty(exports, "selectMessage", { enumerable: true, get: function () { return protocol_2.selectMessage; } });
-Object.defineProperty(exports, "ADMIN_SOURCE", { enumerable: true, get: function () { return protocol_2.ADMIN_SOURCE; } });
-Object.defineProperty(exports, "PROTOCOL_VERSION", { enumerable: true, get: function () { return protocol_2.PROTOCOL_VERSION; } });
-Object.defineProperty(exports, "SITE_SOURCE", { enumerable: true, get: function () { return protocol_2.SITE_SOURCE; } });
+const protocol_js_1 = require("./protocol.js");
+var protocol_js_2 = require("./protocol.js");
+Object.defineProperty(exports, "acceptMessage", { enumerable: true, get: function () { return protocol_js_2.acceptMessage; } });
+Object.defineProperty(exports, "hoverMessage", { enumerable: true, get: function () { return protocol_js_2.hoverMessage; } });
+Object.defineProperty(exports, "normaliseOrigins", { enumerable: true, get: function () { return protocol_js_2.normaliseOrigins; } });
+Object.defineProperty(exports, "patchedText", { enumerable: true, get: function () { return protocol_js_2.patchedText; } });
+Object.defineProperty(exports, "pickCentred", { enumerable: true, get: function () { return protocol_js_2.pickCentred; } });
+Object.defineProperty(exports, "readyMessage", { enumerable: true, get: function () { return protocol_js_2.readyMessage; } });
+Object.defineProperty(exports, "scrollEdge", { enumerable: true, get: function () { return protocol_js_2.scrollEdge; } });
+Object.defineProperty(exports, "selectMessage", { enumerable: true, get: function () { return protocol_js_2.selectMessage; } });
+Object.defineProperty(exports, "textAround", { enumerable: true, get: function () { return protocol_js_2.textAround; } });
+Object.defineProperty(exports, "visibleMessage", { enumerable: true, get: function () { return protocol_js_2.visibleMessage; } });
+Object.defineProperty(exports, "ADMIN_SOURCE", { enumerable: true, get: function () { return protocol_js_2.ADMIN_SOURCE; } });
+Object.defineProperty(exports, "PATCH_MAX_FIELDS", { enumerable: true, get: function () { return protocol_js_2.PATCH_MAX_FIELDS; } });
+Object.defineProperty(exports, "PATCH_MAX_LENGTH", { enumerable: true, get: function () { return protocol_js_2.PATCH_MAX_LENGTH; } });
+Object.defineProperty(exports, "PROTOCOL_VERSION", { enumerable: true, get: function () { return protocol_js_2.PROTOCOL_VERSION; } });
+Object.defineProperty(exports, "SITE_FEATURES", { enumerable: true, get: function () { return protocol_js_2.SITE_FEATURES; } });
+Object.defineProperty(exports, "SITE_SOURCE", { enumerable: true, get: function () { return protocol_js_2.SITE_SOURCE; } });
 const BLUE = "#2563eb";
 const TAGGED = "[data-capa-entry][data-capa-field]";
+/** What a ⌘-click on a tagged element follows when it sits in one. */
+const LINK = "a[href]";
 /** Survives the `location.reload()` fallback so the page comes back where it was. */
 const SCROLL_KEY = "capa-overlay:scrollY";
-/** How long a refresh keeps putting the scroll position back while the page re-renders. */
+/** How long a refresh keeps putting the scroll position back once the page has re-rendered. */
 const RESTORE_WINDOW_MS = 1500;
+/** How long an in-place refresh may take before the page reloads instead. */
+exports.REFRESH_TIMEOUT_MS = 10_000;
+/** `visible` is sent at most this often while the page scrolls. */
+const VISIBLE_THROTTLE_MS = 150;
+/**
+ * Apple platforms open a link with ⌘, Windows and Linux with Ctrl. Read from
+ * the browser's own platform report, falling back to the user agent.
+ */
+function isApple(nav) {
+    if (!nav)
+        return false;
+    const data = nav.userAgentData;
+    return /mac|iphone|ipad|ipod/i.test(data?.platform || nav.platform || nav.userAgent || "");
+}
+/** A usable refresh timeout: a positive number of milliseconds, or the default. */
+function timeoutOf(ms) {
+    return typeof ms === "number" && ms > 0 && Number.isFinite(ms) ? ms : exports.REFRESH_TIMEOUT_MS;
+}
 const noop = () => { };
 let running = null;
 /**
@@ -53,20 +86,33 @@ function startOverlay(options) {
     return running.dispose;
 }
 function createOverlay(initial) {
-    let origins = (0, protocol_1.normaliseOrigins)(initial.adminOrigins ?? []);
+    let origins = (0, protocol_js_1.normaliseOrigins)(initial.adminOrigins ?? []);
     let onRefresh = initial.onRefresh;
+    let refreshTimeout = timeoutOf(initial.refreshTimeoutMs);
+    const apple = isApple(typeof navigator === "undefined" ? undefined : navigator);
+    const linkHint = apple ? "⌘-click to open link" : "Ctrl-click to open link";
     /** The origin that said hello. Every message this page sends goes there and nowhere else. */
     let adminOrigin = null;
     let highlight = null;
     let outlineAll = false;
     let hovered = null;
+    /** The link the pointer is in, when it is also over a tagged element: a ⌘-click follows it. */
+    let hoveredLink = null;
     let lastReady = "";
+    /** Where a refresh keeps the page. `until` is Infinity while the refresh is still pending. */
     let pendingScroll = null;
+    /** Counts refreshes, so only the latest one settles the scroll or reloads. */
+    let refreshes = 0;
+    let refreshTimer = 0;
+    /** True while this overlay replays a ⌘-click as a plain click, which it must let through. */
+    let following = false;
     let layer = null;
     let frame = 0;
     let readyFrame = 0;
     let hoverFrame = 0;
     let lastPointer = null;
+    let visibleTimer = 0;
+    let lastVisible = "";
     const post = (message) => {
         if (!adminOrigin)
             return;
@@ -154,13 +200,16 @@ function createOverlay(initial) {
                     boxes.push(b);
             }
         }
+        // Over a link, the label says how to follow it.
+        const hint = hovered && hoveredLink ? ` · ${linkHint}` : "";
         if (hovered && hovered.isConnected && !active.includes(hovered)) {
-            const b = box(hovered, "hover", hovered.getAttribute("data-capa-field"));
+            const b = box(hovered, "hover", `${hovered.getAttribute("data-capa-field") ?? ""}${hint}`);
             if (b)
                 boxes.push(b);
         }
         active.forEach((el, i) => {
-            const label = i === 0 ? (highlight?.field ?? "entry") : null;
+            const name = i === 0 ? (highlight?.field ?? "entry") : null;
+            const label = el === hovered && hint ? `${name ?? el.getAttribute("data-capa-field") ?? ""}${hint}` : name;
             const b = box(el, "active", label);
             if (b)
                 boxes.push(b);
@@ -188,13 +237,48 @@ function createOverlay(initial) {
         if (!force && key === lastReady)
             return;
         lastReady = key;
-        post((0, protocol_1.readyMessage)(path, entries));
+        post((0, protocol_js_1.readyMessage)(path, entries, protocol_js_1.SITE_FEATURES));
     };
     const scheduleReady = () => {
         if (readyFrame)
             return;
         readyFrame = window.requestAnimationFrame(() => sendReady(false));
     };
+    // ------------------------------------------------------------- visible ---
+    /**
+     * Which tagged element sits at the centre of the viewport, reported when it
+     * changes. The editor's "Follow the page" scrolls the form to match. Sent
+     * only to an admin that has said hello, and only on a change, so a still
+     * page sends nothing.
+     */
+    const reportVisible = () => {
+        visibleTimer = 0;
+        if (!adminOrigin)
+            return;
+        const boxes = tagged().map((el) => {
+            const rect = el.getBoundingClientRect();
+            return {
+                entryId: el.getAttribute("data-capa-entry") ?? "",
+                field: el.getAttribute("data-capa-field") ?? "",
+                top: rect.top,
+                bottom: rect.bottom,
+            };
+        });
+        const edge = (0, protocol_js_1.scrollEdge)(window.scrollY, window.innerHeight, document.documentElement.scrollHeight);
+        const pick = (0, protocol_js_1.pickCentred)(boxes, window.innerHeight, edge);
+        if (!pick)
+            return;
+        const key = `${pick.entryId}\n${pick.field}`;
+        if (key === lastVisible)
+            return;
+        lastVisible = key;
+        post((0, protocol_js_1.visibleMessage)(pick.entryId, pick.field));
+    };
+    const onScroll = () => {
+        render();
+        if (!visibleTimer)
+            visibleTimer = window.setTimeout(reportVisible, VISIBLE_THROTTLE_MS);
+    };
     // -------------------------------------------------------------- scroll ---
     const restoreScroll = () => {
         if (!pendingScroll)
@@ -221,32 +305,128 @@ function createOverlay(initial) {
     catch {
         // Storage blocked (a sandboxed or third-party frame): start at the top.
     }
+    /** The editor scrolled on purpose: stop putting the old position back. */
+    const onScrollIntent = () => {
+        pendingScroll = null;
+    };
+    const reload = (y) => {
+        try {
+            window.sessionStorage.setItem(SCROLL_KEY, String(y));
+        }
+        catch {
+            // Nowhere to keep it; the reload lands at the top.
+        }
+        window.location.reload();
+    };
+    /**
+     * Re-render the draft in place, or reload. While an in-place refresh is
+     * pending the position is held (a page whose re-render moves things keeps
+     * its place), and for a moment after it lands. A refresh that fails, or is
+     * still pending after `refreshTimeout`, reloads from where the editor is.
+     */
     const refresh = () => {
         const y = window.scrollY;
-        if (!onRefresh) {
-            try {
-                window.sessionStorage.setItem(SCROLL_KEY, String(y));
-            }
-            catch {
-                // Nowhere to keep it; the reload lands at the top.
-            }
-            window.location.reload();
+        const refreshFn = onRefresh;
+        if (!refreshFn) {
+            reload(y);
             return;
         }
-        pendingScroll = { y, until: Date.now() + RESTORE_WINDOW_MS };
+        const id = ++refreshes;
+        pendingScroll = { y, until: Infinity };
+        if (refreshTimer)
+            window.clearTimeout(refreshTimer);
+        refreshTimer = window.setTimeout(() => {
+            refreshTimer = 0;
+            if (id === refreshes)
+                reload(pendingScroll?.y ?? window.scrollY);
+        }, refreshTimeout);
         Promise.resolve()
-            .then(() => onRefresh?.())
-            .catch(() => window.location.reload())
-            .finally(() => window.requestAnimationFrame(restoreScroll));
+            .then(() => refreshFn())
+            .then(() => {
+            // A later refresh owns the timer and the scroll from here on.
+            if (id !== refreshes)
+                return;
+            window.clearTimeout(refreshTimer);
+            refreshTimer = 0;
+            if (pendingScroll)
+                pendingScroll = { y: pendingScroll.y, until: Date.now() + RESTORE_WINDOW_MS };
+            window.requestAnimationFrame(restoreScroll);
+        }, () => {
+            if (id !== refreshes)
+                return;
+            window.clearTimeout(refreshTimer);
+            refreshTimer = 0;
+            reload(pendingScroll?.y ?? window.scrollY);
+        });
+    };
+    // ---------------------------------------------------- unsaved text, live ---
+    /** What this overlay last wrote into a text node, and the whitespace it found around the text. */
+    const written = new WeakMap();
+    /** The text node a patch wrote into, by element, so one typed away to nothing is found again. */
+    const writtenIn = new WeakMap();
+    /**
+     * The one text node that holds a tagged element's text: through a chain of
+     * single elements (`<a><span>Book now</span></a>`), and only when there is
+     * exactly one. Text split across elements is not one field's text, and is
+     * left alone. Comments (React's text separators) do not count.
+     */
+    const textNodeOf = (el) => {
+        const kept = writtenIn.get(el);
+        if (kept && kept.parentNode && el.contains(kept))
+            return kept;
+        let node = el;
+        for (;;) {
+            const kids = Array.from(node.childNodes).filter((c) => c.nodeType === 1 || (c.nodeType === 3 && c.data.trim() !== ""));
+            if (kids.length === 1 && kids[0].nodeType === 3)
+                return kids[0];
+            if (kids.length === 1 && kids[0].nodeType === 1) {
+                node = kids[0];
+                continue;
+            }
+            if (kids.length === 0 && node === el) {
+                return Array.from(el.childNodes).find((c) => c.nodeType === 3) ?? null;
+            }
+            return null;
+        }
+    };
+    /**
+     * Put the text being typed into the tagged elements of these fields, while
+     * they show the saved text or what this page last patched them to
+     * (`patchedText`). As text, through a text node's `data`, never as markup.
+     */
+    const applyPatch = (entryId, fields) => {
+        for (const change of fields) {
+            for (const el of matching(entryId, change.field)) {
+                let node = textNodeOf(el);
+                // An empty field shows as an empty element: it takes the first text.
+                if (!node && change.saved.trim() === "" && el.childNodes.length === 0) {
+                    node = document.createTextNode("");
+                    el.appendChild(node);
+                }
+                if (!node)
+                    continue;
+                const before = written.get(node);
+                const around = before ?? (0, protocol_js_1.textAround)(node.data);
+                const next = (0, protocol_js_1.patchedText)(node.data, change, before ? before.text : null, around);
+                if (next === null)
+                    continue;
+                node.data = next;
+                written.set(node, { text: change.value, lead: around.lead, trail: around.trail });
+                writtenIn.set(el, node);
+            }
+        }
+        // The boxes follow the text's new size.
+        render();
     };
     // ------------------------------------------------------------ messages ---
     const onMessage = (event) => {
-        const message = (0, protocol_1.acceptMessage)(event, origins, window.parent);
+        const message = (0, protocol_js_1.acceptMessage)(event, origins, window.parent);
         if (!message)
             return;
         switch (message.type) {
             case "hello":
                 adminOrigin = event.origin;
+                lastVisible = "";
                 sendReady(true);
                 render();
                 return;
@@ -270,34 +450,80 @@ function createOverlay(initial) {
             case "refresh":
                 refresh();
                 return;
+            case "patch":
+                // Only from the admin this page is talking to.
+                if (!adminOrigin || event.origin !== adminOrigin)
+                    return;
+                applyPatch(message.entryId, message.fields);
+                return;
         }
     };
     // --------------------------------------------------------- interaction ---
-    const taggedFrom = (target) => {
+    const closestFrom = (target, selector) => {
         const el = target;
-        return el && typeof el.closest === "function" ? el.closest(TAGGED) : null;
+        return el && typeof el.closest === "function" ? el.closest(selector) : null;
+    };
+    const taggedFrom = (target) => closestFrom(target, TAGGED);
+    /**
+     * A ⌘-click on a tagged link: click the same spot again, without the
+     * modifier, and let it through. The site then follows the link in this
+     * frame exactly as it would for a visitor's click: a Next `<Link>`
+     * navigates client-side, a plain `<a>` loads the page, `target` and the
+     * site's own handlers are honoured. The browser's own ⌘-click would open a
+     * new tab, outside the editor.
+     */
+    const follow = (event) => {
+        const target = event.target;
+        const click = new MouseEvent("click", {
+            bubbles: true,
+            cancelable: true,
+            composed: true,
+            view: window,
+            detail: event.detail,
+            screenX: event.screenX,
+            screenY: event.screenY,
+            clientX: event.clientX,
+            clientY: event.clientY,
+            button: 0,
+        });
+        following = true;
+        try {
+            target.dispatchEvent(click);
+        }
+        finally {
+            following = false;
+        }
     };
     const onClick = (event) => {
         // Only once the admin has said hello: a framed page that is not talking to
-        // Capa keeps its links working.
-        if (!adminOrigin)
+        // Capa keeps its links working. And never the plain click `follow` sends.
+        if (!adminOrigin || following)
             return;
         const el = taggedFrom(event.target);
         if (!el)
             return;
         event.preventDefault();
         event.stopPropagation();
-        post((0, protocol_1.selectMessage)(el.getAttribute("data-capa-entry") ?? "", el.getAttribute("data-capa-field") ?? ""));
+        if ((apple ? event.metaKey : event.ctrlKey) && closestFrom(event.target, LINK)) {
+            follow(event);
+            return;
+        }
+        post((0, protocol_js_1.selectMessage)(el.getAttribute("data-capa-entry") ?? "", el.getAttribute("data-capa-field") ?? ""));
     };
     const updateHover = () => {
         hoverFrame = 0;
         const el = taggedFrom(lastPointer);
-        if (el === hovered)
+        const link = el ? closestFrom(lastPointer, LINK) : null;
+        if (el === hovered && link === hoveredLink)
             return;
+        const moved = el !== hovered;
         hovered = el;
-        post(el
-            ? (0, protocol_1.hoverMessage)(el.getAttribute("data-capa-entry") ?? "", el.getAttribute("data-capa-field"))
-            : (0, protocol_1.hoverMessage)("", null));
+        hoveredLink = link;
+        if (moved) {
+            post(el
+                ? (0, protocol_js_1.hoverMessage)(el.getAttribute("data-capa-entry") ?? "", el.getAttribute("data-capa-field"))
+                : (0, protocol_js_1.hoverMessage)("", null));
+        }
         render();
     };
     const onPointerMove = (event) => {
@@ -320,19 +546,24 @@ function createOverlay(initial) {
         render();
         restoreScroll();
     });
+    const INTENT = ["wheel", "touchmove", "keydown"];
     window.addEventListener("message", onMessage);
-    window.addEventListener("scroll", render, { capture: true, passive: true });
+    window.addEventListener("scroll", onScroll, { capture: true, passive: true });
     window.addEventListener("resize", render, { passive: true });
     window.addEventListener("popstate", scheduleReady);
+    for (const type of INTENT)
+        window.addEventListener(type, onScrollIntent, { capture: true, passive: true });
     document.addEventListener("click", onClick, true);
     document.addEventListener("pointermove", onPointerMove, { capture: true, passive: true });
     document.documentElement.addEventListener("pointerleave", onPointerLeave);
     observer.observe(document.body, { childList: true, subtree: true, characterData: true });
     const dispose = () => {
         window.removeEventListener("message", onMessage);
-        window.removeEventListener("scroll", render, { capture: true });
+        window.removeEventListener("scroll", onScroll, { capture: true });
         window.removeEventListener("resize", render);
         window.removeEventListener("popstate", scheduleReady);
+        for (const type of INTENT)
+            window.removeEventListener(type, onScrollIntent, { capture: true });
         document.removeEventListener("click", onClick, true);
         document.removeEventListener("pointermove", onPointerMove, { capture: true });
         document.documentElement.removeEventListener("pointerleave", onPointerLeave);
@@ -340,6 +571,13 @@ function createOverlay(initial) {
         for (const id of [frame, readyFrame, hoverFrame])
             if (id)
                 window.cancelAnimationFrame(id);
+        if (visibleTimer)
+            window.clearTimeout(visibleTimer);
+        // A refresh still pending when the overlay goes must not reload the page later.
+        if (refreshTimer)
+            window.clearTimeout(refreshTimer);
+        refreshTimer = 0;
+        refreshes++;
         layer?.remove();
         layer = null;
         if (running?.dispose === dispose)
@@ -348,8 +586,9 @@ function createOverlay(initial) {
     return {
         dispose,
         setOptions: (next) => {
-            origins = (0, protocol_1.normaliseOrigins)(next.adminOrigins ?? []);
+            origins = (0, protocol_js_1.normaliseOrigins)(next.adminOrigins ?? []);
             onRefresh = next.onRefresh;
+            refreshTimeout = timeoutOf(next.refreshTimeoutMs);
             if (adminOrigin && !origins.includes(adminOrigin))
                 adminOrigin = null;
         },