@parhelia/core 0.1.12928 → 0.1.12931

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

@@ -1,6 +1,7 @@
 import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
 import { useCallback, useEffect, useRef, useState } from "react";
 import { BRIDGE_DOM_UPDATED_EVENT, MiniMap } from "./MiniMap";
+import { resolveMiniMapVisibility, } from "./minimapVisibility";
 import { useCanvasSelection, useEditContext, useEditContextRef, useFieldsEditContext, useFieldsEditContextRef, } from "../client/editContext";
 import { useSlotContext } from "../views/editorSlotContext";
 import { useDebouncedCallback, useThrottledCallback } from "use-debounce";
@@ -25,6 +26,7 @@ import { Spinner } from "../ui/Spinner";
 import { DeviceToolbar } from "./DeviceToolbar";
 import { FullscreenControls } from "../client/ui/FullscreenControls";
 import { toSitecoreDate } from "../utils/sitecoreDate";
+import { pickVersionAtDate } from "../utils/versionAtDate";
 import { BridgeClient } from "../bridge/BridgeClient";
 import { beginPerfTrace, isPerfTraceActive, isPerfTraceEnabled, perfTraceStep, } from "../perfTrace";
 import { getSuggestionDisplayValue } from "../reviews/suggestionDisplayValue";
@@ -642,6 +644,21 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
     const directOverlayScrollSyncRef = useRef(false);
     const lastBridgeHoverInteractionRef = useRef(undefined);
     const pendingRefreshScrollRef = useRef(undefined);
+    // When the pending refresh scroll was captured, and when the last explicit
+    // scrollBy command (minimap click/wheel) was issued. A capture is only safe
+    // to restore while no explicit command is newer than it: the capture
+    // describes where the canvas happened to be at refresh-request time, and
+    // blindly re-asserting it after the user commanded a scroll yanks the
+    // canvas away from where they sent it.
+    const pendingRefreshScrollCapturedAtRef = useRef(0);
+    const lastExplicitScrollCommandAtRef = useRef(0);
+    // Signature of the last canvas render actually requested (URL sans the
+    // per-request edit_rev nonce, plus the edit revision). When a re-run of the
+    // render effect produces the same signature — e.g. an edit<->suggestions
+    // mode toggle, which changes no host-rendered output — the refresh is
+    // skipped entirely: the bridge learns the mode via setEditorMode, and a
+    // needless refresh would drop scroll position and inline-edit state.
+    const lastRenderSignatureRef = useRef(undefined);
     // Set when a canvas refresh (bridge patch or full reload) has been requested
     // and its result has not landed yet. While in flight, bridgeGeometry still
     // describes the PRE-refresh DOM — a moved component is still measured at its
@@ -671,6 +688,15 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
                 pendingRefreshScrollRef.current = undefined;
             }
         };
+        if (lastExplicitScrollCommandAtRef.current >
+            pendingRefreshScrollCapturedAtRef.current) {
+            // The user commanded a scroll after this position was captured; the
+            // bridge is delivering that newer target. Restoring the stale capture
+            // would fight it (restoreIframeWindowScroll re-asserts for ~150
+            // frames and cancels in-flight smooth scrolls).
+            clearPendingTarget();
+            return;
+        }
         const currentScroll = getIframeWindowScroll(iframe) ??
             observedScroll ?? { x: 0, y: 0 };
         const deltaX = targetScroll.x - currentScroll.x;
@@ -716,6 +742,7 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
     const [loadedIframeSrc, setLoadedIframeSrc] = useState();
     const [scroll, setScroll] = useState(0);
     const [showMiniMap, setShowMiniMap] = useState(false);
+    const miniMapVisibilityMemoryRef = useRef({});
     const [bridgeGeometryRevision, setBridgeGeometryRevision] = useState(0);
     const [bridgeDomRevision, setBridgeDomRevision] = useState(0);
     const bridgeGeometryRevisionRafRef = useRef(null);
@@ -1300,16 +1327,22 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
     const requestBridgeTextCompletion = useCallback(async (interaction, force = false) => {
         const editor = editContextRef.current;
         if (!editor?.enableCompletions || editor.mode === "preview") {
+            console.debug("[Parhelia] text completion skipped", JSON.stringify({
+                enableCompletions: editor?.enableCompletions,
+                mode: editor?.mode,
+            }));
             clearBridgeTextCompletion();
             return;
         }
         const fieldDescriptor = await resolveBridgeFieldDescriptor(interaction);
         if (!fieldDescriptor) {
+            console.debug("[Parhelia] text completion skipped: no field descriptor", JSON.stringify({ elementKey: interaction.elementKey }));
             clearBridgeTextCompletion();
             return;
         }
         const field = await editor.itemsRepository.getField(fieldDescriptor);
         if (!field) {
+            console.debug("[Parhelia] text completion skipped: field not in repository", JSON.stringify(fieldDescriptor));
             clearBridgeTextCompletion();
             return;
         }
@@ -1324,24 +1357,15 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
         if (!elementKey ||
             !hostFieldId ||
             !isBridgePatchableTextField(field, isRichText)) {
+            console.debug("[Parhelia] text completion skipped: not patchable", JSON.stringify({
+                elementKey,
+                hostFieldId,
+                fieldType: field.type,
+                isRichText,
+            }));
             clearBridgeTextCompletion();
             return;
         }
-        const selectedText = selectionMatches && typeof bridgeSelection?.text === "string"
-            ? bridgeSelection.text
-            : typeof interaction.selectedText === "string"
-                ? interaction.selectedText
-                : "";
-        const selectionStartOffset = selectionMatches && typeof bridgeSelection?.startOffset === "number"
-            ? bridgeSelection.startOffset
-            : typeof interaction.selectionStartOffset === "number"
-                ? interaction.selectionStartOffset
-                : undefined;
-        const selectionEndOffset = selectionMatches && typeof bridgeSelection?.endOffset === "number"
-            ? bridgeSelection.endOffset
-            : typeof interaction.selectionEndOffset === "number"
-                ? interaction.selectionEndOffset
-                : undefined;
         const liveSelectionStartOffset = typeof interaction.selectionStartOffset === "number"
             ? interaction.selectionStartOffset
             : undefined;
@@ -1354,6 +1378,19 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
         const bridgeSelectionEndOffset = selectionMatches && typeof bridgeSelection?.endOffset === "number"
             ? bridgeSelection?.endOffset
             : undefined;
+        const selectedText = typeof interaction.selectedText === "string"
+            ? interaction.selectedText
+            : selectionMatches && typeof bridgeSelection?.text === "string"
+                ? bridgeSelection.text
+                : "";
+        const selectionStartOffset = liveSelectionStartOffset ??
+            (selectionMatches && typeof bridgeSelection?.startOffset === "number"
+                ? bridgeSelection.startOffset
+                : undefined);
+        const selectionEndOffset = liveSelectionEndOffset ??
+            (selectionMatches && typeof bridgeSelection?.endOffset === "number"
+                ? bridgeSelection.endOffset
+                : undefined);
         const activeInlineEdit = activeBridgeInlineEditRef.current;
         const activeInlineEditMatches = !!(activeInlineEdit &&
             activeInlineEdit.elementKey === elementKey &&
@@ -1379,7 +1416,7 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
                 !hasLiveInteractionOffsets ||
                 (bridgeSelectionStartOffset === liveSelectionStartOffset &&
                     bridgeSelectionEndOffset === liveSelectionEndOffset);
-            const metadataMatchesLiveOffsets = !selectionSnapshotMatchesLiveOffsets ||
+            const metadataMatchesLiveOffsets = selectionSnapshotMatchesLiveOffsets ||
                 ((contextBefore?.length ?? 0) === interaction.selectionStartOffset &&
                     (contextBefore?.length ?? 0) + selectedText.length ===
                         interaction.selectionEndOffset);
@@ -1490,6 +1527,12 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
                     return;
                 }
             }
+            // Escape leaves insert mode, same as in the editor window itself
+            if (interaction.key === "Escape" &&
+                editContextRef.current?.insertMode) {
+                editContextRef.current.setInsertMode(false);
+                return;
+            }
             if (isBridgeTextCompletionApplyShortcut(interaction)) {
                 if (bridgeTextCompletionRef.current) {
                     applyBridgeTextCompletion();
@@ -2445,7 +2488,11 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
         };
         pageViewContext.requestBridgeGeometry = requestBridgeGeometry;
         const requestBridgeScrollBy = (payload) => {
-            return bridgeClientRef.current?.sendCommand("scrollBy", payload) ?? false;
+            const accepted = bridgeClientRef.current?.sendCommand("scrollBy", payload) ?? false;
+            if (accepted) {
+                lastExplicitScrollCommandAtRef.current = Date.now();
+            }
+            return accepted;
         };
         const requestBridgeRichTextCommand = (payload) => {
             return (bridgeClientRef.current?.sendCommand("applyRichTextCommand", payload) ??
@@ -2531,24 +2578,24 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
         const bridgeDom = pageViewContextRef.current?.bridgeDom;
         const contentHeight = bridgeDom?.scrollHeight ??
             getBridgeGeometryDocumentSize(bridgeGeometry)?.height;
+        const contentWidth = bridgeDom?.viewport.width ?? bridgeGeometry?.viewport.width;
         const clientHeight = iframe.clientHeight;
         if (!contentHeight || !clientHeight)
             return;
-        const upperThreshold = clientHeight + 100; // show minimap if content exceeds this height
         // Check if minimap is enabled in settings and user controls
         const minimapEnabled = editContext.parheliaSettings?.showMinimap !== false &&
             editContext.showMinimap;
         if (!minimapEnabled) {
+            miniMapVisibilityMemoryRef.current = {};
             if (showMiniMap) {
                 setShowMiniMap(false);
             }
             return;
         }
-        if (showMiniMap) {
-            return;
-        }
-        if (contentHeight > upperThreshold) {
-            setShowMiniMap(true);
+        const resolution = resolveMiniMapVisibility(showMiniMap, { contentHeight, contentWidth, clientHeight }, miniMapVisibilityMemoryRef.current);
+        miniMapVisibilityMemoryRef.current = resolution.memory;
+        if (resolution.visible !== showMiniMap) {
+            setShowMiniMap(resolution.visible);
         }
     }, 100);
     useEffect(() => {
@@ -2569,6 +2616,13 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
             editContextRef.current?.setSelectedRange(undefined);
         }
     }, [editContext.mode]);
+    // Version that is valid at the active preview date (based on the versions'
+    // publishing restrictions). Derived outside the refresh effect so the effect
+    // re-runs on the resolved version number, not on itemVersions' identity.
+    const previewDateVersion = editContext.mode === "preview" && editContext.previewDate
+        ? pickVersionAtDate(editContext.itemVersions, editContext.previewDate)
+            ?.version
+        : undefined;
     useEffect(() => {
         if (!pageItemDescriptor ||
             !pageViewContext.editUrl ||
@@ -2587,7 +2641,23 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
             renderUrl.searchParams.set("parhelia_session", editContext.sessionId);
         }
         if (editContext.mode === "preview" && editContext.previewDate) {
-            renderUrl.searchParams.delete("sc_version");
+            // Pin the version that is valid at the preview date. The render URL can
+            // carry the version pin as `sc_version`, `version`, or both; leaving
+            // either behind keeps the page pinned to the previously selected
+            // version, so every pin present must be rewritten. Only update params
+            // that exist: proxied host URLs must not gain sc_* params (they break
+            // Sitecore's httpRequestBegin pipeline — see applyParheliaRenderContext).
+            // sc_date stays on the URL for hosts that resolve datasources by date.
+            if (previewDateVersion != null) {
+                if (renderUrl.searchParams.has("sc_version"))
+                    renderUrl.searchParams.set("sc_version", String(previewDateVersion));
+                if (renderUrl.searchParams.has("version"))
+                    renderUrl.searchParams.set("version", String(previewDateVersion));
+            }
+            else {
+                renderUrl.searchParams.delete("sc_version");
+                renderUrl.searchParams.delete("version");
+            }
             renderUrl.searchParams.set("sc_date", toSitecoreDate(editContext.previewDate));
         }
         // Layout-mode marker. Only set when editing shared layout, paired with the
@@ -2606,21 +2676,42 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
         const currentIframeOrigin = getUrlOrigin(currentIframeUrl);
         const renderUrlIsCrossOrigin = renderUrl.origin !== window.location.origin;
         const iframeOriginChanged = !!(currentIframeOrigin && currentIframeOrigin !== renderUrl.origin);
+        // Proxied host URLs carry the version pin as `version` (sc_* params are
+        // stripped), so consider both param names when detecting a change.
+        const getUrlVersionPin = (url) => url.searchParams.get("sc_version") ?? url.searchParams.get("version");
         const currentVersion = currentIframeUrl
-            ? new URL(currentIframeUrl).searchParams.get("sc_version")
+            ? getUrlVersionPin(new URL(currentIframeUrl))
             : null;
-        const newVersion = renderUrl.searchParams.get("sc_version");
+        const newVersion = getUrlVersionPin(renderUrl);
         const versionChanged = (currentVersion !== null || newVersion !== null) &&
             currentVersion !== newVersion;
         const initialLoad = currentItemDescriptor?.id !== pageItemDescriptor.id ||
             currentItemDescriptor?.language !== pageItemDescriptor.language ||
             currentItemDescriptor?.version !== pageItemDescriptor.version;
         const shouldUseIframeSrcReload = initialLoad || pageViewContext.fullscreen || iframeOriginChanged;
+        const signatureUrl = new URL(renderUrl.toString());
+        signatureUrl.searchParams.delete("edit_rev");
+        const renderSignature = `${signatureUrl.toString()}|rev:${editContext.revision}`;
+        // Only skip when a live bridge confirms the last refresh actually reached
+        // the host. Before the bridge is connected, re-runs must keep going: the
+        // retry/fallback-reload path below is what recovers a canvas whose first
+        // load raced the bridge injection.
+        if (!shouldUseIframeSrcReload &&
+            !versionChanged &&
+            lastRenderSignatureRef.current === renderSignature &&
+            bridgeClientRef.current?.supportsCapability("refresh")) {
+            setCurrentItemDescriptor(pageItemDescriptor);
+            return;
+        }
         function runFallbackRefresh() {
+            lastRenderSignatureRef.current = renderSignature;
             pageViewContext.setIframeSupportsRefresh(false);
-            pendingRefreshScrollRef.current ??=
-                getIframeWindowScroll(iframeRef.current) ??
-                    latestBridgeScrollRef.current;
+            if (!pendingRefreshScrollRef.current) {
+                pendingRefreshScrollRef.current =
+                    getIframeWindowScroll(iframeRef.current) ??
+                        latestBridgeScrollRef.current;
+                pendingRefreshScrollCapturedAtRef.current = Date.now();
+            }
             canvasRefreshInFlightSinceRef.current = Date.now();
             awaitingHostAppRefreshRenderRef.current = false;
             setShowSpinner(true);
@@ -2635,9 +2726,11 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
             setIframeSrc(renderUrl.toString());
         }
         function runBridgeRefresh() {
+            lastRenderSignatureRef.current = renderSignature;
             pendingRefreshScrollRef.current =
                 getIframeWindowScroll(iframeRef.current) ??
                     latestBridgeScrollRef.current;
+            pendingRefreshScrollCapturedAtRef.current = Date.now();
             const bridge = bridgeClientRef.current;
             if (!bridge?.supportsCapability("refresh")) {
                 runFallbackRefresh();
@@ -2686,6 +2779,7 @@ function PageViewerFrameContent({ compareView, pageViewContext, editContext, cla
         pageViewContext.fullscreen,
         editContext.mode,
         editContext.previewDate,
+        previewDateVersion,
         editContext.sessionId,
         editContext.layoutMode,
     ]);