@capacms/sdk 1.0.0-next.7 → 1.0.0-next.9

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.visibleMessage = exports.selectMessage = exports.scrollEdge = exports.readyMessage = exports.pickCentred = exports.normaliseOrigins = exports.hoverMessage = exports.acceptMessage = void 0;
+exports.REFRESH_TIMEOUT_MS = exports.SITE_SOURCE = exports.PROTOCOL_VERSION = exports.ADMIN_SOURCE = exports.visibleMessage = exports.selectMessage = exports.scrollEdge = exports.readyMessage = exports.pickCentred = exports.normaliseOrigins = exports.hoverMessage = exports.acceptMessage = void 0;
 exports.startOverlay = startOverlay;
 /**
  * `@capacms/sdk/overlay`: the site half of Capa's live preview.
@@ -13,30 +13,52 @@ exports.startOverlay = startOverlay;
  * 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, "pickCentred", { enumerable: true, get: function () { return protocol_2.pickCentred; } });
-Object.defineProperty(exports, "readyMessage", { enumerable: true, get: function () { return protocol_2.readyMessage; } });
-Object.defineProperty(exports, "scrollEdge", { enumerable: true, get: function () { return protocol_2.scrollEdge; } });
-Object.defineProperty(exports, "selectMessage", { enumerable: true, get: function () { return protocol_2.selectMessage; } });
-Object.defineProperty(exports, "visibleMessage", { enumerable: true, get: function () { return protocol_2.visibleMessage; } });
-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, "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, "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, "PROTOCOL_VERSION", { enumerable: true, get: function () { return protocol_js_2.PROTOCOL_VERSION; } });
+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;
 /**
@@ -58,15 +80,26 @@ 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;
@@ -161,13 +194,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);
@@ -195,7 +231,7 @@ 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));
     };
     const scheduleReady = () => {
         if (readyFrame)
@@ -222,15 +258,15 @@ function createOverlay(initial) {
                 bottom: rect.bottom,
             };
         });
-        const edge = (0, protocol_1.scrollEdge)(window.scrollY, window.innerHeight, document.documentElement.scrollHeight);
-        const pick = (0, protocol_1.pickCentred)(boxes, window.innerHeight, edge);
+        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_1.visibleMessage)(pick.entryId, pick.field));
+        post((0, protocol_js_1.visibleMessage)(pick.entryId, pick.field));
     };
     const onScroll = () => {
         render();
@@ -263,27 +299,63 @@ 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);
+        });
     };
     // ------------------------------------------------------------ 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) {
@@ -316,31 +388,71 @@ function createOverlay(initial) {
         }
     };
     // --------------------------------------------------------- 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) => {
@@ -363,10 +475,13 @@ function createOverlay(initial) {
         render();
         restoreScroll();
     });
+    const INTENT = ["wheel", "touchmove", "keydown"];
     window.addEventListener("message", onMessage);
     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);
@@ -376,6 +491,8 @@ function createOverlay(initial) {
         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);
@@ -385,6 +502,11 @@ function createOverlay(initial) {
                 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)
@@ -393,8 +515,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;
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacms/sdk",
-  "version": "1.0.0-next.7",
+  "version": "1.0.0-next.9",
   "description": "The TypeScript SDK for Capa's content API: REST and GraphQL reads typed from your models, Next.js caching and live preview, and codegen.",
   "license": "UNLICENSED",
   "homepage": "https://docs.capacms.com/api",
@@ -34,11 +34,19 @@
       "default": "./dist/nextjs/index.js"
     },
     "./overlay": {
+      "import": {
+        "types": "./dist/esm/overlay/index.d.ts",
+        "default": "./dist/esm/overlay/index.js"
+      },
       "types": "./dist/overlay/index.d.ts",
       "default": "./dist/overlay/index.js"
     },
     "./package.json": "./package.json",
     "./nextjs/overlay": {
+      "import": {
+        "types": "./dist/esm/nextjs/overlay.d.ts",
+        "default": "./dist/esm/nextjs/overlay.js"
+      },
       "types": "./dist/nextjs/overlay.d.ts",
       "default": "./dist/nextjs/overlay.js"
     }
@@ -87,8 +95,8 @@
     "@capa/shared": "0.1.0"
   },
   "scripts": {
-    "build": "tsc -p tsconfig.json",
-    "typecheck": "tsc -p tsconfig.json --noEmit",
-    "test": "tsc -p tsconfig.json && node --test test/comments.test.js test/codegen.test.js test/client.test.js test/next-client.test.js test/nextjs.test.js test/webhooks.test.js test/attrs.test.js test/overlay.test.js test/inflate.test.js test/field-names.test.js test/next-graphql.test.js test/graphql-codegen.test.js test/graphql-contract.test.js test/readme-snippets.test.js test/nextjs-app.test.js test/package-json.test.js test/changelog.test.js test/published-docs.test.js test/builder-messages.test.js && tsc -p test/types/tsconfig.consumer.json --noEmit && tsc -p test/types/tsconfig.nonstrict.json --noEmit"
+    "build": "tsc -p tsconfig.json && tsc -p tsconfig.esm.json && node scripts/esm-scope.js",
+    "typecheck": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.esm.json --noEmit",
+    "test": "pnpm run build && node --test test/comments.test.js test/codegen.test.js test/client.test.js test/next-client.test.js test/nextjs.test.js test/webhooks.test.js test/attrs.test.js test/overlay.test.js test/overlay-dom.test.js test/nextjs-overlay-refresh.test.js test/nextjs-overlay-bundle.test.js test/inflate.test.js test/field-names.test.js test/next-graphql.test.js test/graphql-codegen.test.js test/graphql-contract.test.js test/readme-snippets.test.js test/nextjs-app.test.js test/nextjs-preview-app.test.js test/package-json.test.js test/changelog.test.js test/published-docs.test.js test/builder-messages.test.js && tsc -p test/types/tsconfig.consumer.json --noEmit && tsc -p test/types/tsconfig.nonstrict.json --noEmit && tsc -p test/types/tsconfig.next.json --noEmit"
   }
 }