@parhelia/core 0.4.12818 → 0.4.12871

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

@@ -0,0 +1,226 @@
+import { createContext, useContext, useEffect, useSyncExternalStore, } from "react";
+/**
+ * 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 const OVERVIEW_RULER_TONE_PAINT_ORDER = [
+    "comment-resolved",
+    "spelling",
+    "added",
+    "removed",
+    "validation-suggestion",
+    "validation-warning",
+    "suggestion",
+    "validation-error",
+    "comment",
+];
+export 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 const OVERVIEW_RULER_MARK_HEIGHT = 3;
+function paintIndex(tone) {
+    return OVERVIEW_RULER_TONE_PAINT_ORDER.indexOf(tone);
+}
+function mergeLists(a, b) {
+    if (!b?.length)
+        return a;
+    if (!a?.length)
+        return b;
+    return Array.from(new Set([...a, ...b]));
+}
+/**
+ * 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 function buildOverviewRulerMarks(highlights) {
+    const byTone = new Map();
+    for (const highlight of highlights) {
+        const marks = byTone.get(highlight.tone) ?? [];
+        for (const rect of highlight.rects) {
+            marks.push({
+                top: Math.round(rect.y),
+                height: Math.max(Math.round(rect.height), 1),
+                tone: highlight.tone,
+                ...(highlight.ids?.length ? { ids: highlight.ids } : {}),
+                ...(highlight.details?.length ? { details: highlight.details } : {}),
+            });
+        }
+        byTone.set(highlight.tone, marks);
+    }
+    const merged = [];
+    for (const tone of OVERVIEW_RULER_TONE_PAINT_ORDER) {
+        const sorted = (byTone.get(tone) ?? []).sort((a, b) => a.top - b.top);
+        let last;
+        for (const mark of sorted) {
+            if (last && mark.top <= last.top + last.height + 1) {
+                last.height = Math.max(last.height, mark.top + mark.height - last.top);
+                const ids = mergeLists(last.ids, mark.ids);
+                if (ids)
+                    last.ids = ids;
+                const details = mergeLists(last.details, mark.details);
+                if (details)
+                    last.details = details;
+                continue;
+            }
+            last = { ...mark };
+            merged.push(last);
+        }
+    }
+    return merged;
+}
+/**
+ * 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 function layoutOverviewRuler({ sources, extent, }) {
+    const published = Object.entries(sources);
+    if (published.length === 0 || !(extent > 0))
+        return null;
+    return published
+        .flatMap(([source, marks]) => marks.map((mark) => ({ source, mark })))
+        .sort((a, b) => paintIndex(a.mark.tone) - paintIndex(b.mark.tone))
+        .map(({ source, mark }) => ({
+        top: Math.min(Math.max(mark.top / extent, 0), 1),
+        tone: mark.tone,
+        source,
+        mark,
+    }));
+}
+function marksEqual(a, b) {
+    return (a.length === b.length &&
+        a.every((mark, index) => mark.top === b[index].top &&
+            mark.height === b[index].height &&
+            mark.tone === b[index].tone &&
+            listsEqual(mark.ids, b[index].ids) &&
+            listsEqual(mark.details, b[index].details)));
+}
+/** For measurements producing marks: `null` means "no marks to publish". */
+export function overviewRulerMarksEqual(a, b) {
+    return a && b ? marksEqual(a, b) : a === b;
+}
+function listsEqual(a, b) {
+    const left = a ?? [];
+    const right = b ?? [];
+    return (left.length === right.length &&
+        left.every((value, index) => value === right[index]));
+}
+export function createOverviewRulerStore() {
+    let snapshot = { sources: {}, extent: 0 };
+    const listeners = new Set();
+    const handlers = new Map();
+    let scroller = null;
+    const update = (next) => {
+        snapshot = next;
+        listeners.forEach((listener) => listener());
+    };
+    return {
+        getSnapshot: () => snapshot,
+        subscribe(listener) {
+            listeners.add(listener);
+            return () => {
+                listeners.delete(listener);
+            };
+        },
+        /**
+         * `null` withdraws the source; an empty array keeps the source published
+         * with nothing marked.
+         */
+        publish(source, marks) {
+            const current = snapshot.sources[source];
+            if (marks === null ? !current : current && marksEqual(current, marks)) {
+                return;
+            }
+            const sources = { ...snapshot.sources };
+            if (marks === null)
+                delete sources[source];
+            else
+                sources[source] = marks;
+            update({ ...snapshot, sources });
+        },
+        setExtent(extent) {
+            if (extent !== snapshot.extent)
+                update({ ...snapshot, extent });
+        },
+        /** Scrolls the canvas to a mark: what a click does by default. */
+        setScroller(next) {
+            scroller = next;
+        },
+        /** What a click on the source's marks does; not part of the snapshot. */
+        setActivateHandler(source, handler) {
+            if (handler)
+                handlers.set(source, handler);
+            else
+                handlers.delete(source);
+        },
+        activate(source, mark) {
+            const scrollToMark = () => scroller?.(mark);
+            const handler = handlers.get(source);
+            if (handler)
+                handler(mark, scrollToMark);
+            else
+                scrollToMark();
+        },
+    };
+}
+export const OverviewRulerContext = createContext(null);
+export function useOverviewRulerStore() {
+    return useContext(OverviewRulerContext);
+}
+const EMPTY_SNAPSHOT = { sources: {}, extent: 0 };
+const subscribeNothing = () => () => { };
+const getEmptySnapshot = () => EMPTY_SNAPSHOT;
+export function useOverviewRulerSnapshot() {
+    const store = useContext(OverviewRulerContext);
+    return useSyncExternalStore(store?.subscribe ?? subscribeNothing, store?.getSnapshot ?? getEmptySnapshot, store?.getSnapshot ?? getEmptySnapshot);
+}
+/**
+ * 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 function usePublishOverviewRulerMarks(source, marks, onActivate) {
+    const store = useContext(OverviewRulerContext);
+    useEffect(() => {
+        if (source)
+            store?.publish(source, marks);
+    }, [store, source, marks]);
+    useEffect(() => {
+        if (source)
+            store?.setActivateHandler(source, onActivate ?? null);
+    }, [store, source, onActivate]);
+    useEffect(() => {
+        if (!store || !source)
+            return;
+        return () => {
+            store.publish(source, null);
+            store.setActivateHandler(source, null);
+        };
+    }, [store, source]);
+}
+/**
+ * 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 function usePublishOverviewRulerCanvas(extent, scrollToMark) {
+    const store = useContext(OverviewRulerContext);
+    useEffect(() => {
+        store?.setExtent(extent);
+    }, [store, extent]);
+    useEffect(() => {
+        store?.setScroller(scrollToMark);
+    }, [store, scrollToMark]);
+    useEffect(() => {
+        if (!store)
+            return;
+        return () => {
+            store.setExtent(0);
+            store.setScroller(null);
+        };
+    }, [store]);
+}
+//# sourceMappingURL=overviewRuler.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"overviewRuler.js","sourceRoot":"","sources":["../../../src/editor/page-viewer/overviewRuler.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,UAAU,EACV,SAAS,EACT,oBAAoB,GACrB,MAAM,OAAO,CAAC;AAqCf;;;;GAIG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAiC;IAC3E,kBAAkB;IAClB,UAAU;IACV,OAAO;IACP,SAAS;IACT,uBAAuB;IACvB,oBAAoB;IACpB,YAAY;IACZ,kBAAkB;IAClB,SAAS;CACV,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AACvC;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC;AAE5C,SAAS,UAAU,CAAC,IAAuB;IACzC,OAAO,+BAA+B,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,UAAU,CACjB,CAAgC,EAChC,CAAgC;IAEhC,IAAI,CAAC,CAAC,EAAE,MAAM;QAAE,OAAO,CAAC,CAAC;IACzB,IAAI,CAAC,CAAC,EAAE,MAAM;QAAE,OAAO,CAAC,CAAC;IACzB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,UAKE;IAEF,MAAM,MAAM,GAAG,IAAI,GAAG,EAA0C,CAAC;IACjE,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAC/C,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;YACnC,KAAK,CAAC,IAAI,CAAC;gBACT,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;gBACvB,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBAC5C,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACxD,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACrE,CAAC,CAAC;QACL,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,KAAK,MAAM,IAAI,IAAI,+BAA+B,EAAE,CAAC;QACnD,MAAM,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QACtE,IAAI,IAAmC,CAAC;QACxC,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;gBACvE,MAAM,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC3C,IAAI,GAAG;oBAAE,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;gBACxB,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvD,IAAI,OAAO;oBAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;gBACpC,SAAS;YACX,CAAC;YACD,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAqBD;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,EAClC,OAAO,EACP,MAAM,GACgB;IACtB,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAEvC,CAAC;IACF,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IAEzD,OAAO,SAAS;SACb,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;SACrE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACjE,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1B,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAChD,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,MAAM;QACN,IAAI;KACL,CAAC,CAAC,CAAC;AACR,CAAC;AAED,SAAS,UAAU,CAAC,CAAsB,EAAE,CAAsB;IAChE,OAAO,CACL,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QACrB,CAAC,CAAC,KAAK,CACL,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACd,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,KAAK,CAAE,CAAC,GAAG;YAC1B,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,KAAK,CAAE,CAAC,MAAM;YAChC,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,KAAK,CAAE,CAAC,IAAI;YAC5B,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAE,CAAC,GAAG,CAAC;YACnC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAE,CAAC,OAAO,CAAC,CAC9C,CACF,CAAC;AACJ,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,uBAAuB,CACrC,CAA6B,EAC7B,CAA6B;IAE7B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,UAAU,CACjB,CAAgC,EAChC,CAAgC;IAEhC,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;IACrB,MAAM,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC;IACtB,OAAO,CACL,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;QAC5B,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC,CACrD,CAAC;AACJ,CAAC;AAaD,MAAM,UAAU,wBAAwB;IACtC,IAAI,QAAQ,GAA0B,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACjE,MAAM,SAAS,GAAG,IAAI,GAAG,EAAc,CAAC;IACxC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAA8C,CAAC;IACvE,IAAI,QAAQ,GAAiC,IAAI,CAAC;IAClD,MAAM,MAAM,GAAG,CAAC,IAA2B,EAAE,EAAE;QAC7C,QAAQ,GAAG,IAAI,CAAC;QAChB,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC9C,CAAC,CAAC;IAEF,OAAO;QACL,WAAW,EAAE,GAAG,EAAE,CAAC,QAAQ;QAC3B,SAAS,CAAC,QAAoB;YAC5B,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACxB,OAAO,GAAG,EAAE;gBACV,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC7B,CAAC,CAAC;QACJ,CAAC;QACD;;;WAGG;QACH,OAAO,CAAC,MAA2B,EAAE,KAAiC;YACpE,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACzC,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;gBACtE,OAAO;YACT,CAAC;YACD,MAAM,OAAO,GAAG,EAAE,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxC,IAAI,KAAK,KAAK,IAAI;gBAAE,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;;gBACtC,OAAO,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;YAC7B,MAAM,CAAC,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QACnC,CAAC;QACD,SAAS,CAAC,MAAc;YACtB,IAAI,MAAM,KAAK,QAAQ,CAAC,MAAM;gBAAE,MAAM,CAAC,EAAE,GAAG,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;QAClE,CAAC;QACD,kEAAkE;QAClE,WAAW,CAAC,IAAkC;YAC5C,QAAQ,GAAG,IAAI,CAAC;QAClB,CAAC;QACD,yEAAyE;QACzE,kBAAkB,CAChB,MAA2B,EAC3B,OAAqC;YAErC,IAAI,OAAO;gBAAE,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;;gBACtC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;QACD,QAAQ,CAAC,MAA2B,EAAE,IAAuB;YAC3D,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC;YAC5C,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACrC,IAAI,OAAO;gBAAE,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;;gBACpC,YAAY,EAAE,CAAC;QACtB,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,aAAa,CAC/C,IAAI,CACL,CAAC;AAEF,MAAM,UAAU,qBAAqB;IACnC,OAAO,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAC1C,CAAC;AAED,MAAM,cAAc,GAA0B,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;AACzE,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC;AACxC,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC,cAAc,CAAC;AAE9C,MAAM,UAAU,wBAAwB;IACtC,MAAM,KAAK,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;IAC/C,OAAO,oBAAoB,CACzB,KAAK,EAAE,SAAS,IAAI,gBAAgB,EACpC,KAAK,EAAE,WAAW,IAAI,gBAAgB,EACtC,KAAK,EAAE,WAAW,IAAI,gBAAgB,CACvC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAC1C,MAAuC,EACvC,KAAiC,EACjC,UAAkC;IAElC,MAAM,KAAK,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;IAC/C,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,MAAM;YAAE,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IAC3B,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,MAAM;YAAE,KAAK,EAAE,kBAAkB,CAAC,MAAM,EAAE,UAAU,IAAI,IAAI,CAAC,CAAC;IACpE,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;IAChC,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM;YAAE,OAAO;QAC9B,OAAO,GAAG,EAAE;YACV,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC5B,KAAK,CAAC,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACzC,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AACtB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,6BAA6B,CAC3C,MAAc,EACd,YAAmC;IAEnC,MAAM,KAAK,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;IAC/C,SAAS,CAAC,GAAG,EAAE;QACb,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IACpB,SAAS,CAAC,GAAG,EAAE;QACb,KAAK,EAAE,WAAW,CAAC,YAAY,CAAC,CAAC;IACnC,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;IAC1B,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,KAAK;YAAE,OAAO;QACnB,OAAO,GAAG,EAAE;YACV,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACnB,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AACd,CAAC"}

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

@@ -4,16 +4,8 @@ import { EditorConfiguration } from "../../config/types";
 import { ComponentsProviderSettings, type ResolvedPublicSite } from "../services/contentService";
 import { ParheliaSettings, Site } from "../../types";
 import { LayoutMode } from "../client/editContext";
-import type { ApplyFieldPatchCommandPayload, ApplyRichTextCommandPayload, BridgeGeometrySnapshot, BridgeSelectionSnapshot, CaptureComponentSnapshotCommandPayload, CapturePageSnapshotCommandPayload, ComponentSnapshotResultEventPayload, PageSnapshotResultEventPayload, CaptureDomCommandPayload, CaptureDomResultEventPayload, DomUpdatedEventPayload, InteractionEventPayload, PreviewGapCommandPayload, QueryGeometryCommandPayload, ScrollByCommandPayload, SerializablePageStructure } from "../bridge/protocol";
-export declare const DEVICE_CHANGE_EVENT = "parhelia:device-change";
-export declare const PAGE_RESOLVED_EVENT = "parhelia:page-resolved";
-export declare function usePageResolvedSignal(): void;
+import type { ApplyFieldPatchCommandPayload, ApplyRichTextCommandPayload, SetRichTextFieldOptionsCommandPayload, BridgeGeometrySnapshot, BridgeSelectionSnapshot, CaptureComponentSnapshotCommandPayload, CapturePageSnapshotCommandPayload, ComponentSnapshotResultEventPayload, PageSnapshotResultEventPayload, CaptureDomCommandPayload, CaptureDomResultEventPayload, DomUpdatedEventPayload, InteractionEventPayload, PreviewGapCommandPayload, QueryGeometryCommandPayload, ScrollByCommandPayload, SerializablePageStructure } from "../bridge/protocol";
 export declare const CANVAS_REFRESH_COMPLETED_EVENT = "parhelia:canvas-refresh-completed";
-export type DeviceChangeEventDetail = {
-    device?: string;
-    zoom?: number;
-};
-export declare function useViewportChangeSignal(): void;
 export type BridgeGeometryQuery = QueryGeometryCommandPayload & {
     /**
      * Identifies the overlay feature contributing these text ranges (e.g.
@@ -24,47 +16,91 @@ export type BridgeGeometryQuery = QueryGeometryCommandPayload & {
      */
     source?: string;
 };
-export type PageViewContext = {
+/**
+ * Everything a page view knows that changes over time: the viewport, the page
+ * model, where the page resolves to, and the canvas bridge's latest snapshots.
+ *
+ * One immutable object per change. Render code reads it with
+ * {@link usePageViewState}; handlers and effects that run later read the
+ * current one with `pageViewContext.getState()`.
+ */
+export type PageViewState = {
     device: string;
-    setDevice: React.Dispatch<React.SetStateAction<string>>;
-    zoom: number;
-    setZoom: React.Dispatch<React.SetStateAction<number>>;
-    scroll: number;
-    setScroll: React.Dispatch<React.SetStateAction<number>>;
-    fullscreen: boolean;
-    setFullscreen: React.Dispatch<React.SetStateAction<boolean>>;
-    editorIframe: HTMLIFrameElement | null;
-    setEditorIframe: React.Dispatch<React.SetStateAction<HTMLIFrameElement | null>>;
     deviceWidth?: number;
     deviceHeight?: number;
-    setDeviceWidth: React.Dispatch<React.SetStateAction<number | undefined>>;
-    setDeviceHeight: React.Dispatch<React.SetStateAction<number | undefined>>;
     lockHeight: boolean;
-    setLockHeight: React.Dispatch<React.SetStateAction<boolean>>;
+    zoom: number;
+    fullscreen: boolean;
     rotate: boolean;
-    setRotate: React.Dispatch<React.SetStateAction<boolean>>;
-    page?: Page;
-    pageItemDescriptor?: ItemDescriptor;
-    setPageSkeleton: (pageSkeleton: PageSkeleton | undefined) => void;
-    invalidateInsertOptionsCache: () => void;
+    editorIframe: HTMLIFrameElement | null;
     viewport: {
         width: number;
         height: number;
     };
+    page?: Page;
+    /** The page as resolved (a Latest request resolves to a concrete version). */
+    pageItemDescriptor?: ItemDescriptor;
     site?: Site;
     editUrl?: string;
     previewUrl?: string;
     publishedUrl?: string;
     publicSite?: ResolvedPublicSite;
     componentsProviderSettings?: ComponentsProviderSettings;
+    /**
+     * A canvas frame is mounted for this view and has installed the context's
+     * `requestBridge…` commands (they stay installed until it unmounts).
+     */
+    canvasAttached: boolean;
     bridgeReady: boolean;
-    setBridgeReady: React.Dispatch<React.SetStateAction<boolean>>;
     iframeSupportsRefresh: boolean;
-    setIframeSupportsRefresh: React.Dispatch<React.SetStateAction<boolean>>;
     bridgeStructure?: SerializablePageStructure;
-    setBridgeStructure: React.Dispatch<React.SetStateAction<SerializablePageStructure | undefined>>;
     bridgeGeometry?: BridgeGeometrySnapshot;
-    setBridgeGeometry: React.Dispatch<React.SetStateAction<BridgeGeometrySnapshot | undefined>>;
+    bridgeDom?: DomUpdatedEventPayload;
+    bridgeSelection?: BridgeSelectionSnapshot;
+    bridgeInteraction?: InteractionEventPayload;
+};
+type Setter<T> = React.Dispatch<React.SetStateAction<T>>;
+/**
+ * A page view: one canvas (or a form standing in for it) with its viewport,
+ * page model and bridge.
+ *
+ * The object keeps its identity for the life of the view, so it can be stored,
+ * registered and passed down without re-running anything. It holds no value
+ * that changes: those live in its {@link PageViewState}, a new object per
+ * change. A component that shows or depends on state subscribes with
+ * {@link usePageViewState}; the React Compiler memoizes on identities, so a
+ * value read off an object that kept its identity would stay at its first
+ * reading.
+ *
+ * The `requestBridge…` members are commands the mounted canvas frame installs
+ * (and removes on unmount; `canvasAttached` tells); call them from handlers and
+ * effects.
+ */
+export type PageViewContext = {
+    /** Short id for diagnostics: tells the shell, slot and compare contexts apart. */
+    debugId: string;
+    /** The current state. For handlers and effects; render reads use {@link usePageViewState}. */
+    getState: () => PageViewState;
+    /** Calls `listener` after each state change. Returns the unsubscribe. */
+    subscribe: (listener: () => void) => () => void;
+    setDevice: Setter<string>;
+    setZoom: Setter<number>;
+    setFullscreen: Setter<boolean>;
+    setEditorIframe: Setter<HTMLIFrameElement | null>;
+    setDeviceWidth: Setter<number | undefined>;
+    setDeviceHeight: Setter<number | undefined>;
+    setLockHeight: Setter<boolean>;
+    setRotate: Setter<boolean>;
+    setCanvasAttached: Setter<boolean>;
+    setBridgeReady: Setter<boolean>;
+    setIframeSupportsRefresh: Setter<boolean>;
+    setBridgeStructure: Setter<SerializablePageStructure | undefined>;
+    setBridgeGeometry: Setter<BridgeGeometrySnapshot | undefined>;
+    setBridgeDom: Setter<DomUpdatedEventPayload | undefined>;
+    setBridgeSelection: Setter<BridgeSelectionSnapshot | undefined>;
+    setBridgeInteraction: Setter<InteractionEventPayload | undefined>;
+    setPageSkeleton: (pageSkeleton: PageSkeleton | undefined) => void;
+    invalidateInsertOptionsCache: () => void;
     requestBridgeGeometry?: (payload: BridgeGeometryQuery) => boolean;
     requestBridgeScrollBy?: (payload: ScrollByCommandPayload) => boolean;
     requestBridgePreviewGap?: (payload: PreviewGapCommandPayload) => boolean;
@@ -74,15 +110,40 @@ export type PageViewContext = {
     requestBridgeCancelPointerDrag?: () => boolean;
     scrollViaMinimapPoint?: (clientX: number, clientY: number) => boolean;
     requestBridgeRichTextCommand?: (payload: ApplyRichTextCommandPayload) => boolean;
+    requestBridgeRichTextFieldOptions?: (payload: SetRichTextFieldOptionsCommandPayload) => boolean;
     requestBridgeFieldPatch?: (payload: ApplyFieldPatchCommandPayload) => boolean;
     requestBridgeCaptureDom?: (payload: CaptureDomCommandPayload) => Promise<CaptureDomResultEventPayload>;
-    bridgeDom?: DomUpdatedEventPayload;
-    setBridgeDom: React.Dispatch<React.SetStateAction<DomUpdatedEventPayload | undefined>>;
-    bridgeSelection?: BridgeSelectionSnapshot;
-    setBridgeSelection: React.Dispatch<React.SetStateAction<BridgeSelectionSnapshot | undefined>>;
-    bridgeInteraction?: InteractionEventPayload;
-    setBridgeInteraction: React.Dispatch<React.SetStateAction<InteractionEventPayload | undefined>>;
 };
+/** A page view context and the writer of the state it shows. */
+export type PageViewStore = {
+    context: PageViewContext;
+    /** Applies every field of `patch` as one change; a patch that changes nothing notifies no one. */
+    update: (patch: Partial<PageViewState>) => void;
+    /** Where `setPageSkeleton` and `invalidateInsertOptionsCache` go (the view's page model). */
+    bindPageModel: (pageModel: {
+        setPageSkeleton: (pageSkeleton: PageSkeleton | undefined) => void;
+        invalidateInsertOptionsCache: () => void;
+    }) => void;
+};
+/**
+ * Creates a page view context over its own state. {@link usePageViewContext}
+ * makes one per view; tests and previews that need a context without a page
+ * model use this directly.
+ */
+export declare function createPageViewStore(initial?: Partial<PageViewState>): PageViewStore;
+/**
+ * Reads page view state during render and re-renders the caller when the
+ * selected value changes. `select` returns a field (or another value the state
+ * already holds), not a new object: a new object per call never settles.
+ */
+export declare function usePageViewState<T>(pageViewContext: PageViewContext, select: (state: PageViewState) => T): T;
+export declare function usePageViewState<T>(pageViewContext: PageViewContext | null | undefined, select: (state: PageViewState) => T): T | undefined;
+/**
+ * {@link usePageViewState} over a list of page views (e.g. every open editor
+ * slot): one selected value per context, in order. The returned array keeps
+ * its identity while every selected value does.
+ */
+export declare function usePageViewStates<T>(pageViewContexts: readonly PageViewContext[], select: (state: PageViewState) => T): readonly T[];
 export declare function usePageViewContext({ pageItemDescriptor, itemsRepository, configuration, parheliaSettings, layoutMode, }: {
     pageItemDescriptor?: ItemDescriptor;
     itemsRepository?: ItemsRepository;
@@ -90,3 +151,4 @@ export declare function usePageViewContext({ pageItemDescriptor, itemsRepository
     parheliaSettings?: ParheliaSettings;
     layoutMode?: LayoutMode;
 }): PageViewContext;
+export {};