@parhelia/core 0.3.12831 → 0.3.12833

package/dist/editor/page-viewer/interactivePreview.js

@@ -0,0 +1,344 @@
+/**
+ * Interactive preview: running the client code of dynamic renderings safely,
+ * and finding the page's dynamic renderings for the preview strip.
+ *
+ * The client code of a rendering runs in the edit and preview canvas only once
+ * an administrator approved it: the canvas lives on the CM origin with the
+ * user's session. The rendering host wraps every
+ * dynamic rendering in `<div data-parhelia-rendering="<renderingId>">` and, in
+ * preview mode, marks a page that has client code with
+ * `<script data-parhelia-has-client-code="<renderingId>,...">`. To try client
+ * code that is not approved, the review dialog mints a short-lived preview
+ * token and shows a fresh iframe with `sandbox="allow-scripts"` only (an opaque
+ * origin: no cookies, no access to the editor) that loads the page through the
+ * token's capability URL, where all client code runs. The canvas itself is
+ * never replaced.
+ *
+ * This module holds the pure parts: reading the canvas, building the URLs, the
+ * token refresh rule and the session state.
+ */
+export const CLIENT_CODE_HINT_ATTRIBUTE = "data-parhelia-has-client-code";
+export const CLIENT_CODE_HINT_SELECTOR = `script[${CLIENT_CODE_HINT_ATTRIBUTE}]`;
+/** The wrapper the rendering host puts around every dynamic rendering. */
+export const DYNAMIC_RENDERING_ATTRIBUTE = "data-parhelia-rendering";
+export const DYNAMIC_RENDERING_SELECTOR = `[${DYNAMIC_RENDERING_ATTRIBUTE}]`;
+/** The only sandbox flags the interactive frame gets. */
+export const INTERACTIVE_PREVIEW_SANDBOX = "allow-scripts";
+export const PREVIEW_TOKEN_ENDPOINT = "/parhelia/renderings/previewToken";
+export const INTERACTIVE_PREVIEW_PATH_PREFIX = "/parhelia/preview/";
+/** A token is renewed before a reload once it is this close to expiring. */
+export const PREVIEW_TOKEN_REFRESH_MARGIN_SECONDS = 120;
+// At most this many rendering ids are read from a page and sent to the server.
+const MAX_RENDERING_IDS = 100;
+const RENDERING_ID_PATTERN = /^\{?([0-9a-f]{8})-?([0-9a-f]{4})-?([0-9a-f]{4})-?([0-9a-f]{4})-?([0-9a-f]{12})\}?$/i;
+/** A GUID in lower-case "D" format, or undefined when the value is none. */
+export function normalizeRenderingId(value) {
+    const match = RENDERING_ID_PATTERN.exec((value ?? "").trim());
+    return match ? match.slice(1, 6).join("-").toLowerCase() : undefined;
+}
+/**
+ * Rendering ids from one or more attribute values: comma-separated, limited to
+ * well-formed GUIDs, normalized and de-duplicated in order of appearance.
+ */
+export function parseRenderingIds(values) {
+    const ids = [];
+    const seen = new Set();
+    for (const value of values) {
+        for (const raw of (value ?? "").split(",")) {
+            const id = normalizeRenderingId(raw);
+            if (!id || seen.has(id))
+                continue;
+            seen.add(id);
+            ids.push(id);
+            if (ids.length >= MAX_RENDERING_IDS)
+                return ids;
+        }
+    }
+    return ids;
+}
+const NO_RENDERING_IDS = [];
+export const NO_CANVAS_RENDERINGS = {
+    renderingIds: NO_RENDERING_IDS,
+    clientCodeIds: NO_RENDERING_IDS,
+};
+/**
+ * The dynamic renderings in the canvas document. The canvas is normally
+ * same-origin with the editor; any other frame (cross-origin, opaque,
+ * detached) yields none.
+ */
+export function readCanvasRenderings(iframe) {
+    try {
+        const doc = iframe?.contentDocument;
+        if (!doc)
+            return NO_CANVAS_RENDERINGS;
+        const clientCodeIds = parseRenderingIds(Array.from(doc.querySelectorAll(CLIENT_CODE_HINT_SELECTOR), (script) => script.getAttribute(CLIENT_CODE_HINT_ATTRIBUTE)));
+        const renderingIds = parseRenderingIds([
+            ...Array.from(doc.querySelectorAll(DYNAMIC_RENDERING_SELECTOR), (node) => node.getAttribute(DYNAMIC_RENDERING_ATTRIBUTE)),
+            ...clientCodeIds,
+        ]);
+        if (renderingIds.length === 0)
+            return NO_CANVAS_RENDERINGS;
+        return { renderingIds, clientCodeIds };
+    }
+    catch {
+        return NO_CANVAS_RENDERINGS;
+    }
+}
+export function sameRenderingIds(left, right) {
+    return (left.length === right.length &&
+        left.every((id, index) => id === right[index]));
+}
+export function buildPreviewTokenUrl(page) {
+    const params = new URLSearchParams({
+        item: page.id,
+        language: page.language,
+        version: String(page.version),
+    });
+    return `${PREVIEW_TOKEN_ENDPOINT}?${params.toString()}`;
+}
+/**
+ * The token's prefix as a same-origin preview path without a trailing slash,
+ * or undefined for anything else.
+ */
+export function normalizePreviewPrefix(prefix, origin = window.location.origin) {
+    if (typeof prefix !== "string" ||
+        !prefix.startsWith(INTERACTIVE_PREVIEW_PATH_PREFIX) ||
+        /[?#\\]/.test(prefix) ||
+        prefix.split("/").some((segment) => segment === "." || segment === "..")) {
+        return undefined;
+    }
+    let url;
+    try {
+        url = new URL(`${prefix.replace(/\/+$/, "")}/`, origin);
+    }
+    catch {
+        return undefined;
+    }
+    // Encoded dot segments are resolved by the URL parser; what is left must
+    // still be a preview path on the editor's origin.
+    if (url.origin !== new URL(origin).origin ||
+        !url.pathname.startsWith(INTERACTIVE_PREVIEW_PATH_PREFIX)) {
+        return undefined;
+    }
+    return url.pathname.replace(/\/+$/, "");
+}
+// Editor-only parameters of the canvas URL: the sealed frame gets no editing
+// bridge, no editing session and no Sitecore site switch.
+const CANVAS_ONLY_PARAMS = new Set([
+    "edit_rev",
+    "parhelia",
+    "parhelia_session",
+    "parhelia_layout",
+    "sc_site",
+]);
+// The preview proxy runs through Sitecore's request pipeline like the canvas
+// proxy, so the page context travels in the plain parameters the host reads
+// (see applyParheliaRenderContext).
+const PLAIN_CONTEXT_PARAMS = new Map([
+    ["sc_itemid", "itemid"],
+    ["sc_lang", "lang"],
+    ["sc_version", "version"],
+]);
+function getSearchParams(url, origin) {
+    try {
+        return url ? new URL(url, origin).searchParams : new URLSearchParams();
+    }
+    catch {
+        return new URLSearchParams();
+    }
+}
+/**
+ * The interactive frame's URL: the token prefix, then exactly "/" and the
+ * query the preview canvas uses, without the editor's own markers. IIS
+ * rejects paths longer than 260 characters and the token alone takes about
+ * half of that, so the page's route path is never appended: the host resolves
+ * the page by its item id (the `route` parameter rides along when the canvas
+ * has one). The page context always names the version the token was minted
+ * for. Returns undefined for a prefix that is not a same-origin preview path.
+ */
+export function buildInteractivePreviewFrameUrl(prefix, page, canvasUrl, origin = window.location.origin) {
+    const path = normalizePreviewPrefix(prefix, origin);
+    if (!path)
+        return undefined;
+    const url = new URL(`${path}/`, origin);
+    const canvasParams = getSearchParams(canvasUrl, origin);
+    canvasParams.forEach((value, name) => {
+        const key = name.toLowerCase();
+        if (CANVAS_ONLY_PARAMS.has(key))
+            return;
+        const target = PLAIN_CONTEXT_PARAMS.get(key);
+        if (target && canvasParams.has(target))
+            return;
+        url.searchParams.append(target ?? name, value);
+    });
+    url.searchParams.set("itemid", page.id);
+    url.searchParams.set("lang", page.language);
+    url.searchParams.set("version", String(page.version));
+    return url.toString();
+}
+/**
+ * Whether a token must be renewed before the frame is (re)loaded: once it is
+ * older than its lifetime minus the refresh margin. Time alone never reloads
+ * the frame; this is only consulted when the editor reloads it anyway.
+ */
+export function isPreviewTokenDue(session, now) {
+    const renewAfterMs = (session.expiresInSeconds - PREVIEW_TOKEN_REFRESH_MARGIN_SECONDS) * 1000;
+    return now - session.mintedAt >= renewAfterMs;
+}
+export function isPreviewTokenResponse(value) {
+    if (!value || typeof value !== "object")
+        return false;
+    const candidate = value;
+    return (typeof candidate.token === "string" &&
+        candidate.token.length > 0 &&
+        typeof candidate.prefix === "string" &&
+        typeof candidate.expiresInSeconds === "number" &&
+        Number.isFinite(candidate.expiresInSeconds) &&
+        candidate.expiresInSeconds > 0);
+}
+export function createInteractivePreviewSession(response, mintedAt, origin = window.location.origin) {
+    const prefix = normalizePreviewPrefix(response.prefix, origin);
+    if (!prefix)
+        return undefined;
+    return {
+        prefix,
+        expiresInSeconds: response.expiresInSeconds,
+        mintedAt,
+    };
+}
+export function getInteractivePreviewPageKey(page) {
+    if (!page?.id || !page.language)
+        return undefined;
+    return [
+        page.id.replace(/[{}-]/g, "").toLowerCase(),
+        page.language.toLowerCase(),
+        page.version,
+    ].join("|");
+}
+const NO_HINT = NO_CANVAS_RENDERINGS;
+export const INITIAL_INTERACTIVE_PREVIEW_STATE = {
+    status: "off",
+    frameKey: 0,
+    hint: NO_HINT,
+};
+function offState(state) {
+    if (state.status === "off" && !state.session && !state.pendingRequestId) {
+        return state;
+    }
+    return {
+        ...INITIAL_INTERACTIVE_PREVIEW_STATE,
+        frameKey: state.frameKey,
+        hint: state.hint,
+    };
+}
+export function interactivePreviewReducer(state, action) {
+    switch (action.type) {
+        case "hint": {
+            const pageKey = action.renderings.renderingIds.length
+                ? action.pageKey
+                : undefined;
+            if (state.hint.pageKey === pageKey &&
+                sameRenderingIds(state.hint.renderingIds, action.renderings.renderingIds) &&
+                sameRenderingIds(state.hint.clientCodeIds, action.renderings.clientCodeIds)) {
+                return state;
+            }
+            return {
+                ...state,
+                hint: pageKey
+                    ? {
+                        pageKey,
+                        renderingIds: [...action.renderings.renderingIds],
+                        clientCodeIds: [...action.renderings.clientCodeIds],
+                    }
+                    : NO_HINT,
+            };
+        }
+        case "start":
+            // Only a page whose canvas has client code can run it.
+            if (state.status !== "off" ||
+                state.hint.pageKey !== action.pageKey ||
+                state.hint.clientCodeIds.length === 0) {
+                return state;
+            }
+            return {
+                status: "starting",
+                pageKey: action.pageKey,
+                frameKey: state.frameKey,
+                pendingRequestId: action.requestId,
+                hint: state.hint,
+            };
+        case "refreshStarted":
+            if (state.status !== "on")
+                return state;
+            return { ...state, pendingRequestId: action.requestId };
+        case "minted":
+            if (state.status === "off" ||
+                state.pendingRequestId !== action.requestId) {
+                return state;
+            }
+            return {
+                ...state,
+                status: "on",
+                session: action.session,
+                canvasUrl: action.canvasUrl ?? state.canvasUrl,
+                pendingRequestId: undefined,
+                frameKey: state.frameKey + 1,
+            };
+        case "mintFailed":
+            if (state.pendingRequestId !== action.requestId)
+                return state;
+            return offState(state);
+        case "remount":
+            if (state.status !== "on")
+                return state;
+            return {
+                ...state,
+                canvasUrl: action.canvasUrl ?? state.canvasUrl,
+                frameKey: state.frameKey + 1,
+            };
+        case "stop":
+            return offState(state);
+    }
+}
+/**
+ * Whether the interactive frame replaces the canvas right now. Derived rather
+ * than stored so that leaving preview mode or opening another page returns to
+ * the normal canvas in the same render, before any cleanup has run.
+ */
+export function isInteractivePreviewActive(state, context) {
+    return (state.status === "on" &&
+        !!state.session &&
+        context.mode === "preview" &&
+        !!context.pageKey &&
+        state.pageKey === context.pageKey);
+}
+/** A running or starting session that no longer matches the canvas ends. */
+export function shouldStopInteractivePreview(state, context) {
+    return (state.status !== "off" &&
+        (context.mode !== "preview" ||
+            !context.pageKey ||
+            state.pageKey !== context.pageKey));
+}
+function getHintForContext(state, context) {
+    if (context.mode !== "preview" ||
+        !context.pageKey ||
+        state.hint.pageKey !== context.pageKey) {
+        return NO_CANVAS_RENDERINGS;
+    }
+    return state.hint;
+}
+/**
+ * The rendering ids "Run client code" is offered for: only in preview mode,
+ * and only those read from the canvas of the page that is open now.
+ */
+export function getOfferedClientCodeRenderings(state, context) {
+    return getHintForContext(state, context).clientCodeIds;
+}
+/**
+ * The page's dynamic renderings the preview strip lists, under the same
+ * conditions as getOfferedClientCodeRenderings.
+ */
+export function getPreviewRenderingIds(state, context) {
+    return getHintForContext(state, context).renderingIds;
+}
+//# sourceMappingURL=interactivePreview.js.map

package/dist/editor/page-viewer/interactivePreview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interactivePreview.js","sourceRoot":"","sources":["../../../src/editor/page-viewer/interactivePreview.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,MAAM,CAAC,MAAM,0BAA0B,GAAG,+BAA+B,CAAC;AAC1E,MAAM,CAAC,MAAM,yBAAyB,GAAG,UAAU,0BAA0B,GAAG,CAAC;AACjF,0EAA0E;AAC1E,MAAM,CAAC,MAAM,2BAA2B,GAAG,yBAAyB,CAAC;AACrE,MAAM,CAAC,MAAM,0BAA0B,GAAG,IAAI,2BAA2B,GAAG,CAAC;AAE7E,yDAAyD;AACzD,MAAM,CAAC,MAAM,2BAA2B,GAAG,eAAe,CAAC;AAE3D,MAAM,CAAC,MAAM,sBAAsB,GAAG,mCAAmC,CAAC;AAC1E,MAAM,CAAC,MAAM,+BAA+B,GAAG,oBAAoB,CAAC;AAEpE,4EAA4E;AAC5E,MAAM,CAAC,MAAM,oCAAoC,GAAG,GAAG,CAAC;AAExD,+EAA+E;AAC/E,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,oBAAoB,GACxB,qFAAqF,CAAC;AAsBxF,4EAA4E;AAC5E,MAAM,UAAU,oBAAoB,CAClC,KAAgC;IAEhC,MAAM,KAAK,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC9D,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AACvE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAAgD;IAEhD,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,KAAK,MAAM,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3C,MAAM,EAAE,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC;YACrC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAAE,SAAS;YAClC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACb,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACb,IAAI,GAAG,CAAC,MAAM,IAAI,iBAAiB;gBAAE,OAAO,GAAG,CAAC;QAClD,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AASD,MAAM,gBAAgB,GAAa,EAAE,CAAC;AAEtC,MAAM,CAAC,MAAM,oBAAoB,GAAqB;IACpD,YAAY,EAAE,gBAAgB;IAC9B,aAAa,EAAE,gBAAgB;CAChC,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAA4C;IAE5C,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,EAAE,eAAe,CAAC;QACpC,IAAI,CAAC,GAAG;YAAE,OAAO,oBAAoB,CAAC;QACtC,MAAM,aAAa,GAAG,iBAAiB,CACrC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,yBAAyB,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,CACrE,MAAM,CAAC,YAAY,CAAC,0BAA0B,CAAC,CAChD,CACF,CAAC;QACF,MAAM,YAAY,GAAG,iBAAiB,CAAC;YACrC,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,0BAA0B,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CACvE,IAAI,CAAC,YAAY,CAAC,2BAA2B,CAAC,CAC/C;YACD,GAAG,aAAa;SACjB,CAAC,CAAC;QACH,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,oBAAoB,CAAC;QAC3D,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC;IACzC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,oBAAoB,CAAC;IAC9B,CAAC;AACH,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,IAAuB,EACvB,KAAwB;IAExB,OAAO,CACL,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;QAC5B,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC,CAC/C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAA4B;IAC/D,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;QACjC,IAAI,EAAE,IAAI,CAAC,EAAE;QACb,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;KAC9B,CAAC,CAAC;IACH,OAAO,GAAG,sBAAsB,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;AAC1D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAe,EACf,MAAM,GAAW,MAAM,CAAC,QAAQ,CAAC,MAAM;IAEvC,IACE,OAAO,MAAM,KAAK,QAAQ;QAC1B,CAAC,MAAM,CAAC,UAAU,CAAC,+BAA+B,CAAC;QACnD,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;QACrB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,GAAG,IAAI,OAAO,KAAK,IAAI,CAAC,EACxE,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,GAAQ,CAAC;IACb,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,yEAAyE;IACzE,kDAAkD;IAClD,IACE,GAAG,CAAC,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM;QACrC,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,+BAA+B,CAAC,EACzD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAC1C,CAAC;AAED,6EAA6E;AAC7E,0DAA0D;AAC1D,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC;IACjC,UAAU;IACV,UAAU;IACV,kBAAkB;IAClB,iBAAiB;IACjB,SAAS;CACV,CAAC,CAAC;AACH,6EAA6E;AAC7E,4EAA4E;AAC5E,oCAAoC;AACpC,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC;IACnC,CAAC,WAAW,EAAE,QAAQ,CAAC;IACvB,CAAC,SAAS,EAAE,MAAM,CAAC;IACnB,CAAC,YAAY,EAAE,SAAS,CAAC;CAC1B,CAAC,CAAC;AAEH,SAAS,eAAe,CACtB,GAAuB,EACvB,MAAc;IAEd,IAAI,CAAC;QACH,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,eAAe,EAAE,CAAC;IACzE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,eAAe,EAAE,CAAC;IAC/B,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,+BAA+B,CAC7C,MAAc,EACd,IAA4B,EAC5B,SAAkB,EAClB,MAAM,GAAW,MAAM,CAAC,QAAQ,CAAC,MAAM;IAEvC,MAAM,IAAI,GAAG,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpD,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAE5B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,MAAM,CAAC,CAAC;IACxC,MAAM,YAAY,GAAG,eAAe,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IACxD,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QACnC,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAC/B,IAAI,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO;QACxC,MAAM,MAAM,GAAG,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC7C,IAAI,MAAM,IAAI,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC;YAAE,OAAO;QAC/C,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IACxC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACtD,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;AACxB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAyE,EACzE,GAAW;IAEX,MAAM,YAAY,GAChB,CAAC,OAAO,CAAC,gBAAgB,GAAG,oCAAoC,CAAC,GAAG,IAAI,CAAC;IAC3E,OAAO,GAAG,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,KAAc;IAEd,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACtD,MAAM,SAAS,GAAG,KAAsC,CAAC;IACzD,OAAO,CACL,OAAO,SAAS,CAAC,KAAK,KAAK,QAAQ;QACnC,SAAS,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;QAC1B,OAAO,SAAS,CAAC,MAAM,KAAK,QAAQ;QACpC,OAAO,SAAS,CAAC,gBAAgB,KAAK,QAAQ;QAC9C,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,gBAAgB,CAAC;QAC3C,SAAS,CAAC,gBAAgB,GAAG,CAAC,CAC/B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,+BAA+B,CAC7C,QAA8B,EAC9B,QAAgB,EAChB,MAAM,GAAW,MAAM,CAAC,QAAQ,CAAC,MAAM;IAEvC,MAAM,MAAM,GAAG,sBAAsB,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/D,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC9B,OAAO;QACL,MAAM;QACN,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB;QAC3C,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,4BAA4B,CAC1C,IAAwC;IAExC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;QAAE,OAAO,SAAS,CAAC;IAClD,OAAO;QACL,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE;QAC3C,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE;QAC3B,IAAI,CAAC,OAAO;KACb,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACd,CAAC;AAiDD,MAAM,OAAO,GAAyB,oBAAoB,CAAC;AAE3D,MAAM,CAAC,MAAM,iCAAiC,GAA4B;IACxE,MAAM,EAAE,KAAK;IACb,QAAQ,EAAE,CAAC;IACX,IAAI,EAAE,OAAO;CACd,CAAC;AAEF,SAAS,QAAQ,CAAC,KAA8B;IAC9C,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;QACxE,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO;QACL,GAAG,iCAAiC;QACpC,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,IAAI,EAAE,KAAK,CAAC,IAAI;KACjB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,KAA8B,EAC9B,MAAgC;IAEhC,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,MAAM,EAAE,CAAC;YACZ,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,MAAM;gBACnD,CAAC,CAAC,MAAM,CAAC,OAAO;gBAChB,CAAC,CAAC,SAAS,CAAC;YACd,IACE,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO;gBAC9B,gBAAgB,CACd,KAAK,CAAC,IAAI,CAAC,YAAY,EACvB,MAAM,CAAC,UAAU,CAAC,YAAY,CAC/B;gBACD,gBAAgB,CACd,KAAK,CAAC,IAAI,CAAC,aAAa,EACxB,MAAM,CAAC,UAAU,CAAC,aAAa,CAChC,EACD,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO;gBACL,GAAG,KAAK;gBACR,IAAI,EAAE,OAAO;oBACX,CAAC,CAAC;wBACE,OAAO;wBACP,YAAY,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC;wBACjD,aAAa,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC;qBACpD;oBACH,CAAC,CAAC,OAAO;aACZ,CAAC;QACJ,CAAC;QACD,KAAK,OAAO;YACV,uDAAuD;YACvD,IACE,KAAK,CAAC,MAAM,KAAK,KAAK;gBACtB,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,MAAM,CAAC,OAAO;gBACrC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,EACrC,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO;gBACL,MAAM,EAAE,UAAU;gBAClB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,gBAAgB,EAAE,MAAM,CAAC,SAAS;gBAClC,IAAI,EAAE,KAAK,CAAC,IAAI;aACjB,CAAC;QACJ,KAAK,gBAAgB;YACnB,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI;gBAAE,OAAO,KAAK,CAAC;YACxC,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC;QAC1D,KAAK,QAAQ;YACX,IACE,KAAK,CAAC,MAAM,KAAK,KAAK;gBACtB,KAAK,CAAC,gBAAgB,KAAK,MAAM,CAAC,SAAS,EAC3C,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO;gBACL,GAAG,KAAK;gBACR,MAAM,EAAE,IAAI;gBACZ,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS;gBAC9C,gBAAgB,EAAE,SAAS;gBAC3B,QAAQ,EAAE,KAAK,CAAC,QAAQ,GAAG,CAAC;aAC7B,CAAC;QACJ,KAAK,YAAY;YACf,IAAI,KAAK,CAAC,gBAAgB,KAAK,MAAM,CAAC,SAAS;gBAAE,OAAO,KAAK,CAAC;YAC9D,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzB,KAAK,SAAS;YACZ,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI;gBAAE,OAAO,KAAK,CAAC;YACxC,OAAO;gBACL,GAAG,KAAK;gBACR,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS;gBAC9C,QAAQ,EAAE,KAAK,CAAC,QAAQ,GAAG,CAAC;aAC7B,CAAC;QACJ,KAAK,MAAM;YACT,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC;AAOD;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CACxC,KAA8B,EAC9B,OAAkC;IAElC,OAAO,CACL,KAAK,CAAC,MAAM,KAAK,IAAI;QACrB,CAAC,CAAC,KAAK,CAAC,OAAO;QACf,OAAO,CAAC,IAAI,KAAK,SAAS;QAC1B,CAAC,CAAC,OAAO,CAAC,OAAO;QACjB,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAClC,CAAC;AACJ,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,4BAA4B,CAC1C,KAA8B,EAC9B,OAAkC;IAElC,OAAO,CACL,KAAK,CAAC,MAAM,KAAK,KAAK;QACtB,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS;YACzB,CAAC,OAAO,CAAC,OAAO;YAChB,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CACrC,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CACxB,KAA8B,EAC9B,OAAkC;IAElC,IACE,OAAO,CAAC,IAAI,KAAK,SAAS;QAC1B,CAAC,OAAO,CAAC,OAAO;QAChB,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,EACtC,CAAC;QACD,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,8BAA8B,CAC5C,KAA8B,EAC9B,OAAkC;IAElC,OAAO,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,aAAa,CAAC;AACzD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAA8B,EAC9B,OAAkC;IAElC,OAAO,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,YAAY,CAAC;AACxD,CAAC"}

package/dist/editor/page-viewer/minimapViewport.d.ts

@@ -0,0 +1,2 @@
+export declare function resolveMinimapViewportUnits(css: string, width: number, height: number): string;
+export declare function preserveMinimapViewport(doc: Document, width: number, height: number): void;

package/dist/editor/page-viewer/minimapViewport.js

@@ -0,0 +1,34 @@
+// A minimap iframe is as tall as the whole page. Resolve viewport units before
+// loading it so nested cards, spacing and backgrounds retain the live layout.
+export function resolveMinimapViewportUnits(css, width, height) {
+    // Consume strings, comments, URLs and identifiers intact, including escaped
+    // Tailwind selectors. Only CSS dimension tokens should be rewritten.
+    return css.replace(/\/\*[\s\S]*?\*\/|"(?:\\[\s\S]|[^"\\])*"|'(?:\\[\s\S]|[^'\\])*'|url\((?:\\[\s\S]|[^)\\])*\)|[+-]?(?:\d*\.\d+|\d+\.?\d*)(?:e[+-]?\d+)?(?:[a-zA-Z_\u0080-\uFFFF]|\\[^\r\n])(?:[\w\u0080-\uFFFF-]|\\[^\r\n])*|(?:[a-zA-Z_\u0080-\uFFFF-]|\\[^\r\n])(?:[\w\u0080-\uFFFF-]|\\[^\r\n])*/gi, (token) => {
+        const dimension = token.match(/^([+-]?(?:\d*\.\d+|\d+\.?\d*)(?:e[+-]?\d+)?)([dls]?v[wh]|[dls]?vmin|[dls]?vmax)$/i);
+        if (!dimension)
+            return token;
+        const [, amount, unitToken] = dimension;
+        if (amount === undefined || unitToken === undefined)
+            return token;
+        const unit = unitToken.toLowerCase();
+        const size = unit.endsWith("min")
+            ? Math.min(width, height)
+            : unit.endsWith("max")
+                ? Math.max(width, height)
+                : unit.endsWith("h")
+                    ? height
+                    : width;
+        if (!Number.isFinite(size) || size <= 0)
+            return token;
+        return `${Math.round(((Number(amount) * size) / 100) * 1000) / 1000}px`;
+    });
+}
+export function preserveMinimapViewport(doc, width, height) {
+    doc.querySelectorAll("style").forEach((style) => {
+        style.textContent = resolveMinimapViewportUnits(style.textContent || "", width, height);
+    });
+    doc.querySelectorAll("[style]").forEach((element) => {
+        element.setAttribute("style", resolveMinimapViewportUnits(element.getAttribute("style") || "", width, height));
+    });
+}
+//# sourceMappingURL=minimapViewport.js.map

package/dist/editor/page-viewer/minimapViewport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"minimapViewport.js","sourceRoot":"","sources":["../../../src/editor/page-viewer/minimapViewport.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,8EAA8E;AAC9E,MAAM,UAAU,2BAA2B,CACzC,GAAW,EACX,KAAa,EACb,MAAc;IAEd,4EAA4E;IAC5E,qEAAqE;IACrE,OAAO,GAAG,CAAC,OAAO,CAChB,oRAAoR,EACpR,CAAC,KAAK,EAAE,EAAE;QACR,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAC3B,mFAAmF,CACpF,CAAC;QACF,IAAI,CAAC,SAAS;YAAE,OAAO,KAAK,CAAC;QAC7B,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,GAAG,SAAS,CAAC;QACxC,IAAI,MAAM,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS;YAAE,OAAO,KAAK,CAAC;QAClE,MAAM,IAAI,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;YAC/B,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC;YACzB,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACpB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC;gBACzB,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;oBAClB,CAAC,CAAC,MAAM;oBACR,CAAC,CAAC,KAAK,CAAC;QACd,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;QACtD,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC;IAC1E,CAAC,CACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,GAAa,EACb,KAAa,EACb,MAAc;IAEd,GAAG,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC9C,KAAK,CAAC,WAAW,GAAG,2BAA2B,CAC7C,KAAK,CAAC,WAAW,IAAI,EAAE,EACvB,KAAK,EACL,MAAM,CACP,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAClD,OAAO,CAAC,YAAY,CAClB,OAAO,EACP,2BAA2B,CACzB,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,EACnC,KAAK,EACL,MAAM,CACP,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/editor/page-viewer/openPageItems.d.ts

@@ -0,0 +1,29 @@
+import type { ItemDescriptor, Page } from "../pageModel";
+/**
+ * Which items belong to the page the editor has open, according to the
+ * editor's own loaded page model: the page item itself plus every datasource
+ * and rendered item of its components. Bridge payloads name the item they
+ * write to; anything outside this set is not part of the open page and must
+ * not be edited through the canvas.
+ */
+export type OpenPageModel = {
+    page?: Page;
+    pageItemDescriptor?: ItemDescriptor;
+};
+type ItemIdentity = {
+    id?: string | null;
+    language?: string | null;
+    version?: number | null;
+};
+type OpenPageItemEntry = {
+    language: string;
+    version: number;
+};
+export declare function collectOpenPageItems(page: Page): ReadonlyMap<string, readonly OpenPageItemEntry[]>;
+/**
+ * True when the item (id, language and version) belongs to the open page: it
+ * is the page item or an item the loaded page model knows as part of the page.
+ * Without a loaded page nothing but the page item itself qualifies.
+ */
+export declare function isItemPartOfOpenPage(item: ItemIdentity | null | undefined, model: OpenPageModel | null | undefined): boolean;
+export {};

package/dist/editor/page-viewer/openPageItems.js

@@ -0,0 +1,73 @@
+function normalizeItemId(id) {
+    return (id ?? "").replace(/[{}-]/g, "").trim().toLowerCase();
+}
+function normalizeLanguage(language) {
+    return (language ?? "").trim().toLowerCase();
+}
+function addItem(items, item) {
+    const id = normalizeItemId(item?.id);
+    if (!id)
+        return;
+    const version = typeof item?.version === "number" && Number.isFinite(item.version)
+        ? item.version
+        : 0;
+    const entries = items.get(id) ?? [];
+    entries.push({ language: normalizeLanguage(item?.language), version });
+    items.set(id, entries);
+}
+// Not cached: the model is small and this runs once per canvas edit event.
+export function collectOpenPageItems(page) {
+    const items = new Map();
+    addItem(items, page.item);
+    const visited = new Set();
+    const visit = (component) => {
+        if (!component || visited.has(component))
+            return;
+        visited.add(component);
+        addItem(items, component.datasourceItem);
+        component.items?.forEach((item) => addItem(items, item));
+        component.placeholders?.forEach((placeholder) => placeholder.components?.forEach(visit));
+    };
+    visit(page.rootComponent);
+    return items;
+}
+function entryMatches(entry, language, version) {
+    if (entry.language && entry.language !== language)
+        return false;
+    // Version 0 stands for "latest" on either side, as everywhere else in the
+    // editor's item matching.
+    return entry.version === 0 || version === 0 || entry.version === version;
+}
+/**
+ * True when the item (id, language and version) belongs to the open page: it
+ * is the page item or an item the loaded page model knows as part of the page.
+ * Without a loaded page nothing but the page item itself qualifies.
+ */
+export function isItemPartOfOpenPage(item, model) {
+    const id = normalizeItemId(item?.id);
+    const language = normalizeLanguage(item?.language);
+    const version = item?.version;
+    if (!id ||
+        !language ||
+        typeof version !== "number" ||
+        !Number.isFinite(version) ||
+        version < 0) {
+        return false;
+    }
+    const pageItem = model?.pageItemDescriptor;
+    if (pageItem &&
+        normalizeItemId(pageItem.id) === id &&
+        entryMatches({
+            language: normalizeLanguage(pageItem.language),
+            version: pageItem.version ?? 0,
+        }, language, version)) {
+        return true;
+    }
+    const page = model?.page;
+    if (!page)
+        return false;
+    return (collectOpenPageItems(page)
+        .get(id)
+        ?.some((entry) => entryMatches(entry, language, version)) ?? false);
+}
+//# sourceMappingURL=openPageItems.js.map

package/dist/editor/page-viewer/openPageItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openPageItems.js","sourceRoot":"","sources":["../../../src/editor/page-viewer/openPageItems.ts"],"names":[],"mappings":"AAyBA,SAAS,eAAe,CAAC,EAA6B;IACpD,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;AAC/D,CAAC;AAED,SAAS,iBAAiB,CAAC,QAAmC;IAC5D,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;AAC/C,CAAC;AAED,SAAS,OAAO,CACd,KAAuC,EACvC,IAAqC;IAErC,MAAM,EAAE,GAAG,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACrC,IAAI,CAAC,EAAE;QAAE,OAAO;IAChB,MAAM,OAAO,GACX,OAAO,IAAI,EAAE,OAAO,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;QAChE,CAAC,CAAC,IAAI,CAAC,OAAO;QACd,CAAC,CAAC,CAAC,CAAC;IACR,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;IACpC,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IACvE,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;AACzB,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,oBAAoB,CAClC,IAAU;IAEV,MAAM,KAAK,GAAG,IAAI,GAAG,EAA+B,CAAC;IACrD,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAE1B,MAAM,OAAO,GAAG,IAAI,GAAG,EAAa,CAAC;IACrC,MAAM,KAAK,GAAG,CAAC,SAAgC,EAAE,EAAE;QACjD,IAAI,CAAC,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC;YAAE,OAAO;QACjD,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACvB,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;QACzC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;QACzD,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,CAC9C,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,CACvC,CAAC;IACJ,CAAC,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAE1B,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,YAAY,CACnB,KAAwB,EACxB,QAAgB,EAChB,OAAe;IAEf,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAChE,0EAA0E;IAC1E,0BAA0B;IAC1B,OAAO,KAAK,CAAC,OAAO,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC;AAC3E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAClC,IAAqC,EACrC,KAAuC;IAEvC,MAAM,EAAE,GAAG,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAG,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACnD,MAAM,OAAO,GAAG,IAAI,EAAE,OAAO,CAAC;IAC9B,IACE,CAAC,EAAE;QACH,CAAC,QAAQ;QACT,OAAO,OAAO,KAAK,QAAQ;QAC3B,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;QACzB,OAAO,GAAG,CAAC,EACX,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,EAAE,kBAAkB,CAAC;IAC3C,IACE,QAAQ;QACR,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE;QACnC,YAAY,CACV;YACE,QAAQ,EAAE,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAC9C,OAAO,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC;SAC/B,EACD,QAAQ,EACR,OAAO,CACR,EACD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,IAAI,GAAG,KAAK,EAAE,IAAI,CAAC;IACzB,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IAExB,OAAO,CACL,oBAAoB,CAAC,IAAI,CAAC;SACvB,GAAG,CAAC,EAAE,CAAC;QACR,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,KAAK,CACrE,CAAC;AACJ,CAAC"}

package/dist/editor/page-viewer/overviewRuler.d.ts

@@ -0,0 +1,128 @@
+import type { OverlayRect } from "../page-editor-chrome/overlay/geometry";
+/**
+ * The canvas overview ruler: one narrow strip on the canvas's right edge that
+ * maps the whole page onto the visible height, like an editor's scrollbar
+ * map. Comments, suggestions, an agent's changes, spelling mistakes and
+ * validation issues share the strip and differ by colour. Each highlighting publishes its marks as a source, in overlay
+ * (document) pixels; the page's extent in the same pixels scales them. A
+ * click on a mark scrolls the canvas to it, unless its source takes the click
+ * itself (e.g. to open the comment thread).
+ */
+export type OverviewRulerSource = "comments" | "suggestions" | "agent-changes" | "spelling" | "validation";
+export type OverviewRulerTone = "comment" | "comment-resolved" | "suggestion" | "added" | "removed" | "spelling" | "validation-error" | "validation-warning" | "validation-suggestion";
+export type OverviewRulerMark = {
+    top: number;
+    height: number;
+    tone: OverviewRulerTone;
+    /** What the dash stands for (e.g. thread ids), topmost first. */
+    ids?: readonly string[];
+    /** Tooltip lines (e.g. validation messages), topmost first. */
+    details?: readonly string[];
+};
+/**
+ * Paint order where marks overlap: later tones draw over earlier ones, so an
+ * open comment or a validation error stays visible on top of the text it is
+ * about, and the many small spelling marks never hide anything.
+ */
+export declare const OVERVIEW_RULER_TONE_PAINT_ORDER: readonly OverviewRulerTone[];
+export declare const OVERVIEW_RULER_WIDTH = 10;
+/**
+ * Every mark is a line of this height in ruler pixels, at the top of what it
+ * marks, however long the marked text is: the ruler shows where, not how much.
+ */
+export declare const OVERVIEW_RULER_MARK_HEIGHT = 3;
+/**
+ * Collapses highlight rects into ruler dashes: one dash per run of marks, so a
+ * paragraph of highlights reads as a single mark instead of a stack of
+ * overlapping slivers. Each tone is merged on its own, in paint order; a
+ * merged dash keeps the ids and details of everything it covers.
+ */
+export declare function buildOverviewRulerMarks(highlights: ReadonlyArray<{
+    tone: OverviewRulerTone;
+    rects: OverlayRect[];
+    ids?: readonly string[];
+    details?: readonly string[];
+}>): OverviewRulerMark[];
+export type OverviewRulerSources = Partial<Record<OverviewRulerSource, OverviewRulerMark[]>>;
+export type OverviewRulerSnapshot = {
+    sources: OverviewRulerSources;
+    /** Page height in the marks' pixels; 0 while unknown. */
+    extent: number;
+};
+/** A mark placed on the ruler, as a fraction (0–1) of the ruler's height. */
+export type OverviewRulerPlacedMark = {
+    top: number;
+    tone: OverviewRulerTone;
+    source: OverviewRulerSource;
+    /** The published mark, handed back to its source on a click. */
+    mark: OverviewRulerMark;
+};
+/**
+ * Every published mark in paint order, scaled from page pixels to fractions of
+ * the ruler. Null while no source is published or the page extent is unknown.
+ */
+export declare function layoutOverviewRuler({ sources, extent, }: OverviewRulerSnapshot): OverviewRulerPlacedMark[] | null;
+/** For measurements producing marks: `null` means "no marks to publish". */
+export declare function overviewRulerMarksEqual(a: OverviewRulerMark[] | null, b: OverviewRulerMark[] | null): boolean;
+/** `scrollToMark` is the ruler's own click action, for handlers adding to it. */
+export type OverviewRulerActivate = (mark: OverviewRulerMark, scrollToMark: () => void) => void;
+/** How the canvas scrolls a mark into view. */
+export type OverviewRulerScroller = (mark: OverviewRulerMark) => void;
+export type OverviewRulerStore = ReturnType<typeof createOverviewRulerStore>;
+export declare function createOverviewRulerStore(): {
+    getSnapshot: () => OverviewRulerSnapshot;
+    subscribe(listener: () => void): () => void;
+    /**
+     * `null` withdraws the source; an empty array keeps the source published
+     * with nothing marked.
+     */
+    publish(source: OverviewRulerSource, marks: OverviewRulerMark[] | null): void;
+    setExtent(extent: number): void;
+    /** Scrolls the canvas to a mark: what a click does by default. */
+    setScroller(next: OverviewRulerScroller | null): void;
+    /** What a click on the source's marks does; not part of the snapshot. */
+    setActivateHandler(source: OverviewRulerSource, handler: OverviewRulerActivate | null): void;
+    activate(source: OverviewRulerSource, mark: OverviewRulerMark): void;
+};
+export declare const OverviewRulerContext: import("react").Context<{
+    getSnapshot: () => OverviewRulerSnapshot;
+    subscribe(listener: () => void): () => void;
+    /**
+     * `null` withdraws the source; an empty array keeps the source published
+     * with nothing marked.
+     */
+    publish(source: OverviewRulerSource, marks: OverviewRulerMark[] | null): void;
+    setExtent(extent: number): void;
+    /** Scrolls the canvas to a mark: what a click does by default. */
+    setScroller(next: OverviewRulerScroller | null): void;
+    /** What a click on the source's marks does; not part of the snapshot. */
+    setActivateHandler(source: OverviewRulerSource, handler: OverviewRulerActivate | null): void;
+    activate(source: OverviewRulerSource, mark: OverviewRulerMark): void;
+} | null>;
+export declare function useOverviewRulerStore(): {
+    getSnapshot: () => OverviewRulerSnapshot;
+    subscribe(listener: () => void): () => void;
+    /**
+     * `null` withdraws the source; an empty array keeps the source published
+     * with nothing marked.
+     */
+    publish(source: OverviewRulerSource, marks: OverviewRulerMark[] | null): void;
+    setExtent(extent: number): void;
+    /** Scrolls the canvas to a mark: what a click does by default. */
+    setScroller(next: OverviewRulerScroller | null): void;
+    /** What a click on the source's marks does; not part of the snapshot. */
+    setActivateHandler(source: OverviewRulerSource, handler: OverviewRulerActivate | null): void;
+    activate(source: OverviewRulerSource, mark: OverviewRulerMark): void;
+} | null;
+export declare function useOverviewRulerSnapshot(): OverviewRulerSnapshot;
+/**
+ * Publishes marks into the surrounding ruler (a no-op outside one, e.g. on
+ * the minimap, or without a `source`). Pass memoized marks; `null` keeps the
+ * source out of the ruler. `onActivate` replaces scrolling to a clicked mark.
+ */
+export declare function usePublishOverviewRulerMarks(source: OverviewRulerSource | undefined, marks: OverviewRulerMark[] | null, onActivate?: OverviewRulerActivate): void;
+/**
+ * Connects the ruler to its canvas: the page height the marks are scaled
+ * against (0 = unknown) and how to scroll the canvas to a mark.
+ */
+export declare function usePublishOverviewRulerCanvas(extent: number, scrollToMark: OverviewRulerScroller): void;