@parhelia/core 0.4.12825 → 0.4.12872

package/dist/editor/page-editor-chrome/overlay/useOverlayViewportRight.js

@@ -0,0 +1,34 @@
+import { useEffect, useState } from "react";
+import { useIframeOverlay } from "./IframeOverlayProvider";
+/**
+ * Right edge of the visible canvas viewport in overlay (document) coordinates.
+ * Unlike `viewportWidth` alone this follows horizontal scrolling, so a line
+ * drawn to the viewport edge keeps reaching it after the page scrolled
+ * sideways. Updated on every scroll and measurement pass.
+ */
+export function getOverlayViewportRight(metrics) {
+    return (metrics.scrollLeft * metrics.scrollScale * metrics.visualScale +
+        metrics.viewportWidth);
+}
+export function useOverlayViewportRight() {
+    const overlay = useIframeOverlay();
+    const [right, setRight] = useState(() => getOverlayViewportRight(overlay.getMetrics()));
+    useEffect(() => {
+        const update = (metrics) => {
+            const next = getOverlayViewportRight(metrics);
+            setRight((current) => (current === next ? current : next));
+        };
+        update(overlay.getMetrics());
+        const unsubscribeScroll = overlay.subscribeScroll(update);
+        const unsubscribeMeasurement = overlay.subscribeMeasurement(update, [
+            "viewport",
+            "layout",
+        ]);
+        return () => {
+            unsubscribeScroll();
+            unsubscribeMeasurement();
+        };
+    }, [overlay]);
+    return right;
+}
+//# sourceMappingURL=useOverlayViewportRight.js.map

package/dist/editor/page-editor-chrome/overlay/useOverlayViewportRight.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useOverlayViewportRight.js","sourceRoot":"","sources":["../../../../src/editor/page-editor-chrome/overlay/useOverlayViewportRight.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,OAAuB;IAC7D,OAAO,CACL,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW;QAC9D,OAAO,CAAC,aAAa,CACtB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uBAAuB;IACrC,MAAM,OAAO,GAAG,gBAAgB,EAAE,CAAC;IACnC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE,CACtC,uBAAuB,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAC9C,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,MAAM,GAAG,CAAC,OAAuB,EAAE,EAAE;YACzC,MAAM,IAAI,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;YAC9C,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7D,CAAC,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QAC7B,MAAM,iBAAiB,GAAG,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,sBAAsB,GAAG,OAAO,CAAC,oBAAoB,CAAC,MAAM,EAAE;YAClE,UAAU;YACV,QAAQ;SACT,CAAC,CAAC;QACH,OAAO,GAAG,EAAE;YACV,iBAAiB,EAAE,CAAC;YACpB,sBAAsB,EAAE,CAAC;QAC3B,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAEd,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/editor/page-editor-chrome/overlay/useSuggestionAnchorMeasurements.d.ts

@@ -0,0 +1,49 @@
+import type { SuggestedEdit } from "../../../types";
+import type { EditContextType } from "../../client/editContext";
+import { type PageViewContext } from "../../page-viewer/pageViewContext";
+import { type SuggestionRangeData } from "../../reviews/feedbackScrollTarget";
+import { type AnchorMeasurements } from "./feedbackAnchorMeasurements";
+export declare const SUGGESTION_BRIDGE_SOURCE = "suggestions";
+export type SuggestionFieldValue = {
+    rawValue: string;
+    itemId: string;
+    language: string;
+    version: number;
+    fieldId: string;
+};
+export type SuggestionAnchorMeasurementsOptions = {
+    /** See `useCommentAnchorMeasurements`. */
+    request?: boolean;
+};
+export type SuggestionAnchorMeasurementsResult = {
+    measurements: AnchorMeasurements;
+    hiddenSuggestionIds: Set<string>;
+    rangeDataBySuggestionId: Record<string, SuggestionRangeData>;
+    fieldValueByIdentity: Record<string, SuggestionFieldValue>;
+    fieldIdentityBySuggestionId: Record<string, string>;
+    previewsSuggestedText: (suggestion: SuggestedEdit) => boolean;
+};
+/** Suggestions that still need a decision and therefore mark the canvas. */
+export declare function getOpenSuggestions(suggestedEdits: SuggestedEdit[]): SuggestedEdit[];
+/**
+ * The single suggestion whose suggested text the canvas shows because its
+ * card is selected. A decided suggestion is never previewed (an applied one
+ * already is the field's text, a rejected one left the original), so
+ * selecting one leaves the field as it is and must not hide its open
+ * siblings on that field.
+ */
+export declare function getPreviewedSuggestionId({ suggestions, selectedSuggestedEditId, previewsAllSuggestions, showSelectedSuggestionOnPage, }: {
+    suggestions: readonly SuggestedEdit[];
+    selectedSuggestedEditId: string | undefined;
+    previewsAllSuggestions: boolean;
+    showSelectedSuggestionOnPage: boolean | undefined;
+}): string | undefined;
+/**
+ * Resolves each suggestion to the text ranges it changes (diffing its old
+ * and new value against the field's current value) and measures those ranges
+ * on the canvas. Callers pass the open suggestions for highlighting, or every
+ * listed suggestion when the measurements also position margin cards.
+ *
+ * Must run inside an `IframeOverlayProvider`.
+ */
+export declare function useSuggestionAnchorMeasurements(pageViewContext: PageViewContext, editContext: EditContextType | undefined, suggestions: SuggestedEdit[], options?: SuggestionAnchorMeasurementsOptions): SuggestionAnchorMeasurementsResult;

package/dist/editor/page-editor-chrome/overlay/useSuggestionAnchorMeasurements.js

@@ -0,0 +1,241 @@
+import { useCallback, useEffect, useMemo, useRef, useState } from "react";
+import { usePageViewState, } from "../../page-viewer/pageViewContext";
+import { getSuggestedEditTextRangeKey, getSuggestionDisplayRanges, getSuggestionRangeData, } from "../../reviews/feedbackScrollTarget";
+import { getSuggestedEditItemLanguage, getSuggestedEditItemVersion, getSuggestionFieldIdentityKey, } from "../../reviews/suggestionDisplayValue";
+import { measureBridgeTextRangeRects } from "./geometry";
+import { anchorMeasurementsEqual, } from "./feedbackAnchorMeasurements";
+import { useBridgeTextRangeRequest, } from "./useBridgeTextRangeRequest";
+import { useOverlayMeasurement } from "./useOverlayMeasurement";
+export const SUGGESTION_BRIDGE_SOURCE = "suggestions";
+/** Suggestions that still need a decision and therefore mark the canvas. */
+export function getOpenSuggestions(suggestedEdits) {
+    return suggestedEdits.filter((suggestion) => suggestion.status !== "applied" && suggestion.status !== "rejected");
+}
+/**
+ * The single suggestion whose suggested text the canvas shows because its
+ * card is selected. A decided suggestion is never previewed (an applied one
+ * already is the field's text, a rejected one left the original), so
+ * selecting one leaves the field as it is and must not hide its open
+ * siblings on that field.
+ */
+export function getPreviewedSuggestionId({ suggestions, selectedSuggestedEditId, previewsAllSuggestions, showSelectedSuggestionOnPage, }) {
+    if (previewsAllSuggestions || showSelectedSuggestionOnPage === false) {
+        return undefined;
+    }
+    const selectedIsDecided = suggestions.some((suggestion) => suggestion.id === selectedSuggestedEditId &&
+        (suggestion.status === "applied" || suggestion.status === "rejected"));
+    return selectedIsDecided ? undefined : selectedSuggestedEditId;
+}
+/**
+ * Resolves each suggestion to the text ranges it changes (diffing its old
+ * and new value against the field's current value) and measures those ranges
+ * on the canvas. Callers pass the open suggestions for highlighting, or every
+ * listed suggestion when the measurements also position margin cards.
+ *
+ * Must run inside an `IframeOverlayProvider`.
+ */
+export function useSuggestionAnchorMeasurements(pageViewContext, editContext, suggestions, options = {}) {
+    const { request = true } = options;
+    const bridgeGeometry = usePageViewState(pageViewContext, (state) => state.bridgeGeometry);
+    const lastMeasurementsRef = useRef({});
+    const [rangeDataBySuggestionId, setRangeDataBySuggestionId] = useState({});
+    const [fieldValueByIdentity, setFieldValueByIdentity] = useState({});
+    const [fieldIdentityBySuggestionId, setFieldIdentityBySuggestionId] = useState({});
+    const previewsAllSuggestions = editContext?.mode === "suggestions";
+    const selectedSuggestedEditId = editContext?.selectedSuggestedEdit?.id;
+    // Outside suggestions mode the selected card previews its suggestion on the
+    // canvas exactly like suggestions mode does (while its "Show on page"
+    // toggle is on), so its ranges must target the suggested text rather than
+    // the original. With the toggle off the canvas keeps the original text and
+    // the ranges mark the text the suggestion removes.
+    const previewedSuggestionId = getPreviewedSuggestionId({
+        suggestions,
+        selectedSuggestedEditId,
+        previewsAllSuggestions,
+        showSelectedSuggestionOnPage: editContext?.showSelectedSuggestionOnPage,
+    });
+    // Decided suggestions are measured too (the comment margin anchors their
+    // cards) but never previewed: an applied one lives in the field as its new
+    // text, a rejected one left the original text in place.
+    const previewsSuggestedText = useCallback((suggestion) => {
+        if (suggestion.status === "applied")
+            return true;
+        if (suggestion.status === "rejected")
+            return false;
+        return previewsAllSuggestions || suggestion.id === previewedSuggestionId;
+    }, [previewsAllSuggestions, previewedSuggestionId]);
+    useEffect(() => {
+        if (!editContext) {
+            setRangeDataBySuggestionId({});
+            setFieldValueByIdentity({});
+            setFieldIdentityBySuggestionId({});
+            return;
+        }
+        let cancelled = false;
+        const resolveRanges = async () => {
+            const nextRangeData = {};
+            const nextFieldValues = {};
+            const nextFieldIdentities = {};
+            await Promise.all(suggestions.map(async (suggestion) => {
+                if (!suggestion.fieldId) {
+                    nextRangeData[suggestion.id] = {
+                        oldRanges: [],
+                        newRanges: [],
+                        oldAnchorOffsets: [],
+                        newAnchorOffsets: [],
+                        oldText: "",
+                        newText: "",
+                    };
+                    return;
+                }
+                const language = getSuggestedEditItemLanguage(suggestion);
+                const version = getSuggestedEditItemVersion(suggestion) ?? 0;
+                const field = await editContext.itemsRepository.getField({
+                    item: {
+                        id: suggestion.itemId,
+                        language,
+                        version,
+                    },
+                    fieldId: suggestion.fieldId,
+                });
+                const resolvedItem = field?.descriptor?.item ?? {
+                    id: suggestion.itemId,
+                    language,
+                    version,
+                };
+                const identityKey = getSuggestionFieldIdentityKey({
+                    itemId: resolvedItem.id,
+                    language: resolvedItem.language,
+                    version: resolvedItem.version,
+                    fieldId: suggestion.fieldId,
+                });
+                nextFieldIdentities[suggestion.id] = identityKey;
+                nextFieldValues[identityKey] = {
+                    rawValue: field?.rawValue ?? "",
+                    itemId: resolvedItem.id,
+                    language: resolvedItem.language,
+                    version: resolvedItem.version,
+                    fieldId: suggestion.fieldId,
+                };
+                nextRangeData[suggestion.id] = getSuggestionRangeData(suggestion.oldValue ?? field?.rawValue ?? "", suggestion.newValue ?? "");
+            }));
+            if (!cancelled) {
+                setRangeDataBySuggestionId(nextRangeData);
+                setFieldValueByIdentity(nextFieldValues);
+                setFieldIdentityBySuggestionId(nextFieldIdentities);
+            }
+        };
+        resolveRanges();
+        return () => {
+            cancelled = true;
+        };
+    }, [editContext, suggestions]);
+    // While a single selected suggestion is previewed, the canvas shows its
+    // suggested text; other pending suggestions on that same field still hold
+    // ranges into the original text and would land at the wrong offsets.
+    const hiddenSuggestionIds = useMemo(() => {
+        const hidden = new Set();
+        if (!previewedSuggestionId)
+            return hidden;
+        const previewedIdentity = fieldIdentityBySuggestionId[previewedSuggestionId];
+        if (!previewedIdentity)
+            return hidden;
+        for (const suggestion of suggestions) {
+            if (suggestion.id !== previewedSuggestionId &&
+                fieldIdentityBySuggestionId[suggestion.id] === previewedIdentity) {
+                hidden.add(suggestion.id);
+            }
+        }
+        return hidden;
+    }, [fieldIdentityBySuggestionId, previewedSuggestionId, suggestions]);
+    const bridgeTextRanges = useMemo(() => suggestions.flatMap((suggestion) => {
+        if (!suggestion.fieldId)
+            return [];
+        if (hiddenSuggestionIds.has(suggestion.id))
+            return [];
+        const rangeData = rangeDataBySuggestionId[suggestion.id];
+        if (!rangeData)
+            return [];
+        const ranges = getSuggestionDisplayRanges(rangeData, previewsSuggestedText(suggestion) ? "new" : "old");
+        const fieldIdentity = fieldIdentityBySuggestionId[suggestion.id];
+        const resolvedField = fieldIdentity
+            ? fieldValueByIdentity[fieldIdentity]
+            : undefined;
+        return ranges.map(([start, end]) => ({
+            key: getSuggestedEditTextRangeKey(suggestion),
+            fieldId: suggestion.fieldId,
+            item: {
+                id: resolvedField?.itemId ?? suggestion.itemId,
+                language: resolvedField?.language ??
+                    getSuggestedEditItemLanguage(suggestion),
+                version: resolvedField?.version ??
+                    getSuggestedEditItemVersion(suggestion) ??
+                    0,
+            },
+            start,
+            end,
+        }));
+    }), [
+        fieldIdentityBySuggestionId,
+        fieldValueByIdentity,
+        hiddenSuggestionIds,
+        previewsSuggestedText,
+        rangeDataBySuggestionId,
+        suggestions,
+    ]);
+    useBridgeTextRangeRequest(pageViewContext, SUGGESTION_BRIDGE_SOURCE, bridgeTextRanges, request);
+    const measurements = useOverlayMeasurement((metrics, reasons) => {
+        if (!bridgeGeometry)
+            return {};
+        const canReusePreviousMeasurement = !reasons.has("viewport") &&
+            !reasons.has("layout") &&
+            !reasons.has("text");
+        const nextMeasurements = {};
+        for (const suggestion of suggestions) {
+            if (!suggestion.fieldId)
+                continue;
+            if (hiddenSuggestionIds.has(suggestion.id))
+                continue;
+            const rangeData = rangeDataBySuggestionId[suggestion.id];
+            if (!rangeData)
+                continue;
+            const ranges = getSuggestionDisplayRanges(rangeData, previewsSuggestedText(suggestion) ? "new" : "old");
+            if (ranges.length === 0)
+                continue;
+            const rects = measureBridgeTextRangeRects(bridgeGeometry, getSuggestedEditTextRangeKey(suggestion), metrics);
+            if (rects.length === 0) {
+                const previousMeasurement = lastMeasurementsRef.current[suggestion.id];
+                if (canReusePreviousMeasurement &&
+                    previousMeasurement?.isTextRange &&
+                    previousMeasurement.rects.length) {
+                    nextMeasurements[suggestion.id] = previousMeasurement;
+                }
+                continue;
+            }
+            nextMeasurements[suggestion.id] = { rects, isTextRange: true };
+        }
+        return nextMeasurements;
+    }, [
+        bridgeGeometry,
+        hiddenSuggestionIds,
+        previewsSuggestedText,
+        suggestions,
+        rangeDataBySuggestionId,
+    ], {
+        initialValue: {},
+        equals: anchorMeasurementsEqual,
+        interests: ["viewport", "layout", "text", "adornment-data"],
+    });
+    useEffect(() => {
+        lastMeasurementsRef.current = measurements;
+    }, [measurements]);
+    return {
+        measurements,
+        hiddenSuggestionIds,
+        rangeDataBySuggestionId,
+        fieldValueByIdentity,
+        fieldIdentityBySuggestionId,
+        previewsSuggestedText,
+    };
+}
+//# sourceMappingURL=useSuggestionAnchorMeasurements.js.map

package/dist/editor/page-editor-chrome/overlay/useSuggestionAnchorMeasurements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSuggestionAnchorMeasurements.js","sourceRoot":"","sources":["../../../../src/editor/page-editor-chrome/overlay/useSuggestionAnchorMeasurements.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAG1E,OAAO,EAEL,gBAAgB,GACjB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,4BAA4B,EAC5B,0BAA0B,EAC1B,sBAAsB,GAEvB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,4BAA4B,EAC5B,2BAA2B,EAC3B,6BAA6B,GAC9B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,EAEL,uBAAuB,GACxB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAEL,yBAAyB,GAC1B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,MAAM,CAAC,MAAM,wBAAwB,GAAG,aAAa,CAAC;AAwBtD,4EAA4E;AAC5E,MAAM,UAAU,kBAAkB,CAAC,cAA+B;IAChE,OAAO,cAAc,CAAC,MAAM,CAC1B,CAAC,UAAU,EAAE,EAAE,CACb,UAAU,CAAC,MAAM,KAAK,SAAS,IAAI,UAAU,CAAC,MAAM,KAAK,UAAU,CACtE,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CAAC,EACvC,WAAW,EACX,uBAAuB,EACvB,sBAAsB,EACtB,4BAA4B,GAM7B;IACC,IAAI,sBAAsB,IAAI,4BAA4B,KAAK,KAAK,EAAE,CAAC;QACrE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,iBAAiB,GAAG,WAAW,CAAC,IAAI,CACxC,CAAC,UAAU,EAAE,EAAE,CACb,UAAU,CAAC,EAAE,KAAK,uBAAuB;QACzC,CAAC,UAAU,CAAC,MAAM,KAAK,SAAS,IAAI,UAAU,CAAC,MAAM,KAAK,UAAU,CAAC,CACxE,CAAC;IACF,OAAO,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,uBAAuB,CAAC;AACjE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,+BAA+B,CAC7C,eAAgC,EAChC,WAAwC,EACxC,WAA4B,EAC5B,OAAO,GAAwC,EAAE;IAEjD,MAAM,EAAE,OAAO,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IACnC,MAAM,cAAc,GAAG,gBAAgB,CACrC,eAAe,EACf,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,cAAc,CAChC,CAAC;IACF,MAAM,mBAAmB,GAAG,MAAM,CAAqB,EAAE,CAAC,CAAC;IAC3D,MAAM,CAAC,uBAAuB,EAAE,0BAA0B,CAAC,GAAG,QAAQ,CAEpE,EAAE,CAAC,CAAC;IACN,MAAM,CAAC,oBAAoB,EAAE,uBAAuB,CAAC,GAAG,QAAQ,CAE9D,EAAE,CAAC,CAAC;IACN,MAAM,CAAC,2BAA2B,EAAE,8BAA8B,CAAC,GACjE,QAAQ,CAAyB,EAAE,CAAC,CAAC;IACvC,MAAM,sBAAsB,GAAG,WAAW,EAAE,IAAI,KAAK,aAAa,CAAC;IACnE,MAAM,uBAAuB,GAAG,WAAW,EAAE,qBAAqB,EAAE,EAAE,CAAC;IACvE,4EAA4E;IAC5E,sEAAsE;IACtE,0EAA0E;IAC1E,2EAA2E;IAC3E,mDAAmD;IACnD,MAAM,qBAAqB,GAAG,wBAAwB,CAAC;QACrD,WAAW;QACX,uBAAuB;QACvB,sBAAsB;QACtB,4BAA4B,EAAE,WAAW,EAAE,4BAA4B;KACxE,CAAC,CAAC;IACH,yEAAyE;IACzE,2EAA2E;IAC3E,wDAAwD;IACxD,MAAM,qBAAqB,GAAG,WAAW,CACvC,CAAC,UAAyB,EAAE,EAAE;QAC5B,IAAI,UAAU,CAAC,MAAM,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QACjD,IAAI,UAAU,CAAC,MAAM,KAAK,UAAU;YAAE,OAAO,KAAK,CAAC;QACnD,OAAO,sBAAsB,IAAI,UAAU,CAAC,EAAE,KAAK,qBAAqB,CAAC;IAC3E,CAAC,EACD,CAAC,sBAAsB,EAAE,qBAAqB,CAAC,CAChD,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,0BAA0B,CAAC,EAAE,CAAC,CAAC;YAC/B,uBAAuB,CAAC,EAAE,CAAC,CAAC;YAC5B,8BAA8B,CAAC,EAAE,CAAC,CAAC;YACnC,OAAO;QACT,CAAC;QAED,IAAI,SAAS,GAAG,KAAK,CAAC;QAEtB,MAAM,aAAa,GAAG,KAAK,IAAI,EAAE;YAC/B,MAAM,aAAa,GAAwC,EAAE,CAAC;YAC9D,MAAM,eAAe,GAAyC,EAAE,CAAC;YACjE,MAAM,mBAAmB,GAA2B,EAAE,CAAC;YAEvD,MAAM,OAAO,CAAC,GAAG,CACf,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;gBACnC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;oBACxB,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG;wBAC7B,SAAS,EAAE,EAAE;wBACb,SAAS,EAAE,EAAE;wBACb,gBAAgB,EAAE,EAAE;wBACpB,gBAAgB,EAAE,EAAE;wBACpB,OAAO,EAAE,EAAE;wBACX,OAAO,EAAE,EAAE;qBACZ,CAAC;oBACF,OAAO;gBACT,CAAC;gBAED,MAAM,QAAQ,GAAG,4BAA4B,CAAC,UAAU,CAAC,CAAC;gBAC1D,MAAM,OAAO,GAAG,2BAA2B,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;gBAC7D,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,eAAe,CAAC,QAAQ,CAAC;oBACvD,IAAI,EAAE;wBACJ,EAAE,EAAE,UAAU,CAAC,MAAM;wBACrB,QAAQ;wBACR,OAAO;qBACR;oBACD,OAAO,EAAE,UAAU,CAAC,OAAO;iBAC5B,CAAC,CAAC;gBAEH,MAAM,YAAY,GAAG,KAAK,EAAE,UAAU,EAAE,IAAI,IAAI;oBAC9C,EAAE,EAAE,UAAU,CAAC,MAAM;oBACrB,QAAQ;oBACR,OAAO;iBACR,CAAC;gBACF,MAAM,WAAW,GAAG,6BAA6B,CAAC;oBAChD,MAAM,EAAE,YAAY,CAAC,EAAE;oBACvB,QAAQ,EAAE,YAAY,CAAC,QAAQ;oBAC/B,OAAO,EAAE,YAAY,CAAC,OAAO;oBAC7B,OAAO,EAAE,UAAU,CAAC,OAAO;iBAC5B,CAAC,CAAC;gBACH,mBAAmB,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC;gBACjD,eAAe,CAAC,WAAW,CAAC,GAAG;oBAC7B,QAAQ,EAAE,KAAK,EAAE,QAAQ,IAAI,EAAE;oBAC/B,MAAM,EAAE,YAAY,CAAC,EAAE;oBACvB,QAAQ,EAAE,YAAY,CAAC,QAAQ;oBAC/B,OAAO,EAAE,YAAY,CAAC,OAAO;oBAC7B,OAAO,EAAE,UAAU,CAAC,OAAO;iBAC5B,CAAC;gBAEF,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG,sBAAsB,CACnD,UAAU,CAAC,QAAQ,IAAI,KAAK,EAAE,QAAQ,IAAI,EAAE,EAC5C,UAAU,CAAC,QAAQ,IAAI,EAAE,CAC1B,CAAC;YACJ,CAAC,CAAC,CACH,CAAC;YAEF,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,0BAA0B,CAAC,aAAa,CAAC,CAAC;gBAC1C,uBAAuB,CAAC,eAAe,CAAC,CAAC;gBACzC,8BAA8B,CAAC,mBAAmB,CAAC,CAAC;YACtD,CAAC;QACH,CAAC,CAAC;QAEF,aAAa,EAAE,CAAC;QAEhB,OAAO,GAAG,EAAE;YACV,SAAS,GAAG,IAAI,CAAC;QACnB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;IAE/B,wEAAwE;IACxE,0EAA0E;IAC1E,qEAAqE;IACrE,MAAM,mBAAmB,GAAG,OAAO,CAAC,GAAG,EAAE;QACvC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;QACjC,IAAI,CAAC,qBAAqB;YAAE,OAAO,MAAM,CAAC;QAC1C,MAAM,iBAAiB,GACrB,2BAA2B,CAAC,qBAAqB,CAAC,CAAC;QACrD,IAAI,CAAC,iBAAiB;YAAE,OAAO,MAAM,CAAC;QACtC,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACrC,IACE,UAAU,CAAC,EAAE,KAAK,qBAAqB;gBACvC,2BAA2B,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,iBAAiB,EAChE,CAAC;gBACD,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,CAAC,2BAA2B,EAAE,qBAAqB,EAAE,WAAW,CAAC,CAAC,CAAC;IAEtE,MAAM,gBAAgB,GAAG,OAAO,CAC9B,GAAG,EAAE,CACH,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QACjC,IAAI,CAAC,UAAU,CAAC,OAAO;YAAE,OAAO,EAAE,CAAC;QACnC,IAAI,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YAAE,OAAO,EAAE,CAAC;QACtD,MAAM,SAAS,GAAG,uBAAuB,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,SAAS;YAAE,OAAO,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAG,0BAA0B,CACvC,SAAS,EACT,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAClD,CAAC;QAEF,MAAM,aAAa,GAAG,2BAA2B,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACjE,MAAM,aAAa,GAAG,aAAa;YACjC,CAAC,CAAC,oBAAoB,CAAC,aAAa,CAAC;YACrC,CAAC,CAAC,SAAS,CAAC;QACd,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YACnC,GAAG,EAAE,4BAA4B,CAAC,UAAU,CAAC;YAC7C,OAAO,EAAE,UAAU,CAAC,OAAQ;YAC5B,IAAI,EAAE;gBACJ,EAAE,EAAE,aAAa,EAAE,MAAM,IAAI,UAAU,CAAC,MAAM;gBAC9C,QAAQ,EACN,aAAa,EAAE,QAAQ;oBACvB,4BAA4B,CAAC,UAAU,CAAC;gBAC1C,OAAO,EACL,aAAa,EAAE,OAAO;oBACtB,2BAA2B,CAAC,UAAU,CAAC;oBACvC,CAAC;aACJ;YACD,KAAK;YACL,GAAG;SACJ,CAAC,CAAC,CAAC;IACN,CAAC,CAAC,EACJ;QACE,2BAA2B;QAC3B,oBAAoB;QACpB,mBAAmB;QACnB,qBAAqB;QACrB,uBAAuB;QACvB,WAAW;KACZ,CACF,CAAC;IAEF,yBAAyB,CACvB,eAAe,EACf,wBAAwB,EACxB,gBAAgB,EAChB,OAAO,CACR,CAAC;IAEF,MAAM,YAAY,GAAG,qBAAqB,CACxC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QACnB,IAAI,CAAC,cAAc;YAAE,OAAO,EAAE,CAAC;QAC/B,MAAM,2BAA2B,GAC/B,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;YACxB,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;YACtB,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEvB,MAAM,gBAAgB,GAAuB,EAAE,CAAC;QAEhD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACrC,IAAI,CAAC,UAAU,CAAC,OAAO;gBAAE,SAAS;YAClC,IAAI,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBAAE,SAAS;YACrD,MAAM,SAAS,GAAG,uBAAuB,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YACzD,IAAI,CAAC,SAAS;gBAAE,SAAS;YAEzB,MAAM,MAAM,GAAG,0BAA0B,CACvC,SAAS,EACT,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAClD,CAAC;YAEF,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YAElC,MAAM,KAAK,GAAG,2BAA2B,CACvC,cAAc,EACd,4BAA4B,CAAC,UAAU,CAAC,EACxC,OAAO,CACR,CAAC;YACF,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvB,MAAM,mBAAmB,GACvB,mBAAmB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;gBAC7C,IACE,2BAA2B;oBAC3B,mBAAmB,EAAE,WAAW;oBAChC,mBAAmB,CAAC,KAAK,CAAC,MAAM,EAChC,CAAC;oBACD,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG,mBAAmB,CAAC;gBACxD,CAAC;gBACD,SAAS;YACX,CAAC;YAED,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;QACjE,CAAC;QAED,OAAO,gBAAgB,CAAC;IAC1B,CAAC,EACD;QACE,cAAc;QACd,mBAAmB;QACnB,qBAAqB;QACrB,WAAW;QACX,uBAAuB;KACxB,EACD;QACE,YAAY,EAAE,EAAE;QAChB,MAAM,EAAE,uBAAuB;QAC/B,SAAS,EAAE,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,gBAAgB,CAAC;KAC5D,CACF,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,mBAAmB,CAAC,OAAO,GAAG,YAAY,CAAC;IAC7C,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAEnB,OAAO;QACL,YAAY;QACZ,mBAAmB;QACnB,uBAAuB;QACvB,oBAAoB;QACpB,2BAA2B;QAC3B,qBAAqB;KACtB,CAAC;AACJ,CAAC"}

package/dist/editor/page-editor-chrome/useBridgeInlineEditing.d.ts

@@ -4,6 +4,13 @@ import type { FieldDescriptor } from "../pageModel";
 import type { PageViewContext } from "../page-viewer/pageViewContext";
 import type { BridgeInlineEditIdentity, BridgeInlineEditSessionCoordinator } from "../page-viewer/bridgeInlineEditSession";
 import type { ApplyFieldPatchCommandPayload, BeginInlineEditCommandPayload, CancelInlineEditCommandPayload, FieldValueChangedEventPayload, InlineEditEndedEventPayload, InteractionEventPayload } from "../bridge/protocol";
+/**
+ * How long a canvas edit waits for the editor's page model to include the
+ * item it writes to. A component inserted moments ago is in the canvas before
+ * the page model has reloaded with it, and under load that reload takes
+ * seconds; typing into the new component in between must not be lost.
+ */
+export declare const OPEN_PAGE_ITEM_WAIT_MS = 15000;
 export type BridgeInlineEditInteraction = InteractionEventPayload & Pick<BeginInlineEditCommandPayload, "selectedText" | "selectionStartOffset" | "selectionEndOffset">;
 type UseBridgeInlineEditingOptions = {
     pageViewContextRef: MutableRefObject<PageViewContext | undefined>;

package/dist/editor/page-editor-chrome/useBridgeInlineEditing.js

@@ -1,10 +1,39 @@
 import { useCallback, useEffect, useRef } from "react";
 import { useEditContextRef, useFieldsEditContextRef, } from "../client/editContext";
 import { getComponentById } from "../componentTreeHelper";
-import { getBridgeFieldPatchValue, isBridgePatchableTextField, } from "../page-viewer/bridgeFieldPatch";
+import { getBridgeFieldPatchValue, isBridgeWritableTextField, } from "../page-viewer/bridgeFieldPatch";
+import { isItemPartOfOpenPage } from "../page-viewer/openPageItems";
 import { useSlotContext } from "../views/editorSlotContext";
 import { logFieldValueDiagnostic, summarizeField, summarizeFieldDescriptor, summarizeFieldValue, } from "../fieldValueDiagnostics";
 import { normalizeMarkerId } from "../utils";
+/**
+ * How long a canvas edit waits for the editor's page model to include the
+ * item it writes to. A component inserted moments ago is in the canvas before
+ * the page model has reloaded with it, and under load that reload takes
+ * seconds; typing into the new component in between must not be lost.
+ */
+export const OPEN_PAGE_ITEM_WAIT_MS = 15_000;
+function waitForItemInOpenPage(pageViewContext, item) {
+    if (!pageViewContext)
+        return Promise.resolve(false);
+    if (isItemPartOfOpenPage(item, pageViewContext.getState())) {
+        return Promise.resolve(true);
+    }
+    return new Promise((resolve) => {
+        let timer;
+        const unsubscribe = pageViewContext.subscribe(() => {
+            if (!isItemPartOfOpenPage(item, pageViewContext.getState()))
+                return;
+            clearTimeout(timer);
+            unsubscribe();
+            resolve(true);
+        });
+        timer = setTimeout(() => {
+            unsubscribe();
+            resolve(isItemPartOfOpenPage(item, pageViewContext.getState()));
+        }, OPEN_PAGE_ITEM_WAIT_MS);
+    });
+}
 export function useBridgeInlineEditing({ pageViewContextRef, inlineEditSession, blockIframeBlurUntil, sendBeginInlineEdit, sendCancelInlineEdit, sendApplyFieldPatch, }) {
     const editContextRef = useEditContextRef();
     const fieldsContextRef = useFieldsEditContextRef();
@@ -15,6 +44,10 @@ export function useBridgeInlineEditing({ pageViewContextRef, inlineEditSession,
     const supersededInlineSessionIdsRef = useRef(new Set());
     const inlineSessionFieldsRef = useRef(new Map());
     const fieldEditGenerationsRef = useRef(new Map());
+    // Per field, the number of canvas value changes received so far. Each change
+    // carries the whole field value, so one that waited must not land after a
+    // newer one.
+    const fieldValueChangeCountsRef = useRef(new Map());
     const pendingFieldValueChangesRef = useRef(new Set());
     const rememberInlineSession = useCallback((sessionId, field) => {
         if (!sessionId)
@@ -90,7 +123,7 @@ export function useBridgeInlineEditing({ pageViewContextRef, inlineEditSession,
     const resolveFieldDescriptor = useCallback((fieldId, item, elementKey) => {
         if (!fieldId)
             return undefined;
-        const pageView = pageViewContextRef.current;
+        const pageView = pageViewContextRef.current?.getState();
         const structureField = pageView?.bridgeStructure?.fields.find((field) => (elementKey && field.elementKey === elementKey) ||
             (field.fieldId === fieldId &&
                 (!item?.id || field.item?.id === item.id)));
@@ -149,8 +182,29 @@ export function useBridgeInlineEditing({ pageViewContextRef, inlineEditSession,
             });
             return;
         }
-        const value = (payload.value ?? "").replaceAll("\u200B", "");
         const valueKey = getBridgeFieldKey(field);
+        const changeCount = (fieldValueChangeCountsRef.current.get(valueKey) ?? 0) + 1;
+        fieldValueChangeCountsRef.current.set(valueKey, changeCount);
+        // The payload names the item it writes to. Only the open page and the
+        // items its loaded page model knows (component datasources and rendered
+        // items) may be written through the canvas. An item the model does not
+        // know yet (a component inserted moments ago) is waited for.
+        if (!(await waitForItemInOpenPage(pageViewContextRef.current, field.item))) {
+            logFieldValueDiagnostic("bridge-inline", "fieldValueChanged skipped", {
+                reason: "item is not part of the open page",
+                field: summarizeFieldDescriptor(field),
+                elementKey: payload.elementKey,
+            });
+            return;
+        }
+        if (fieldValueChangeCountsRef.current.get(valueKey) !== changeCount) {
+            logFieldValueDiagnostic("bridge-inline", "fieldValueChanged skipped", {
+                reason: "a newer value arrived while waiting for the page model",
+                field: summarizeFieldDescriptor(field),
+            });
+            return;
+        }
+        const value = (payload.value ?? "").replaceAll("\u200B", "");
         const fieldGeneration = fieldEditGenerationsRef.current.get(valueKey) ?? 0;
         rememberInlineSession(payload.sessionId, field);
         const previousValue = lastBridgeInlineValueRef.current.get(valueKey);
@@ -198,9 +252,11 @@ export function useBridgeInlineEditing({ pageViewContextRef, inlineEditSession,
         };
         const modeAtStartOnEntry = resolveSessionModeAtStart();
         const editorModeOnEntry = editor.mode;
+        // The field type comes from the editor's field model; the payload's
+        // isRichText flag must not widen what the canvas may write.
         const currentField = await editor.itemsRepository.getField(field);
         if (!currentField ||
-            !isBridgePatchableTextField(currentField, payload.isRichText)) {
+            !isBridgeWritableTextField(currentField, payload.isRichText)) {
             logFieldValueDiagnostic("bridge-inline", "fieldValueChanged skipped", {
                 reason: !currentField ? "field not found" : "field not patchable",
                 field: summarizeFieldDescriptor(field),
@@ -277,6 +333,7 @@ export function useBridgeInlineEditing({ pageViewContextRef, inlineEditSession,
         editContextRef,
         ensureBridgeFieldLock,
         inlineEditSession,
+        pageViewContextRef,
         rejectInlineEdit,
         resolveFieldDescriptor,
         rememberInlineSession,
@@ -393,7 +450,7 @@ export function useBridgeInlineEditing({ pageViewContextRef, inlineEditSession,
             });
             return false;
         }
-        const page = pageViewContextRef.current?.page;
+        const page = pageViewContextRef.current?.getState().page;
         if (editor.mode === "edit" &&
             (editor.readonly ||
                 (page &&
@@ -440,11 +497,21 @@ export function useBridgeInlineEditing({ pageViewContextRef, inlineEditSession,
         }
         blockIframeBlurUntil(Date.now() + 500);
         const shouldRequestLock = editor.mode !== "suggestions";
-        const focused = (await fieldsContextRef.current?.setFocusedField(resolvedField, false)) ?? false;
-        const hasLock = focused &&
-            (!shouldRequestLock ||
-                hasOwnCanonicalFieldLock(editor, resolvedField) ||
-                (await editor.operations.ensureLock(resolvedField, { force: true })));
+        const hostEditorFocus = watchHostEditorFocus();
+        let hasLock;
+        try {
+            const focused = (await fieldsContextRef.current?.setFocusedField(resolvedField, false)) ?? false;
+            hasLock =
+                focused &&
+                    (!shouldRequestLock ||
+                        hasOwnCanonicalFieldLock(editor, resolvedField) ||
+                        (await editor.operations.ensureLock(resolvedField, {
+                            force: true,
+                        })));
+        }
+        finally {
+            hostEditorFocus.stop();
+        }
         if (!hasLock) {
             logBridgeInlineEditDiagnostic("skipped: lock failed", {
                 fieldId: resolvedField.fieldId,
@@ -462,6 +529,19 @@ export function useBridgeInlineEditing({ pageViewContextRef, inlineEditSession,
             });
             return false;
         }
+        // The lock round trip can take a while under load. If the user clicked
+        // into another editor meanwhile (the field form, a comment box), the
+        // begin command would focus the canvas field and take the caret away
+        // from where they are typing.
+        if (hostEditorFocus.movedToHostEditor()) {
+            logBridgeInlineEditDiagnostic("skipped: focus moved to the editor UI while locking", {
+                fieldId: resolvedField.fieldId,
+                itemId: resolvedField.item.id,
+                elementKey: interaction.elementKey,
+                sessionId: options?.sessionId,
+            });
+            return false;
+        }
         const beginPayload = {
             elementKey: interaction.elementKey,
             fieldId: resolvedField.fieldId,
@@ -476,6 +556,7 @@ export function useBridgeInlineEditing({ pageViewContextRef, inlineEditSession,
             beginPayload.selectionEndOffset = interaction.selectionEndOffset;
         }
         const sent = sendBeginInlineEdit(beginPayload);
+        logFieldValueDiagnostic("bridge-inline", `begin command ${sent ? "sent" : "not sent"} field=${resolvedField.fieldId} session=${options?.sessionId ?? "none"}`);
         return sent;
     }, [
         blockIframeBlurUntil,
@@ -542,6 +623,48 @@ function hasOwnCanonicalFieldLock(editor, field) {
     return editor.activeSessions.some((session) => session.sessionId === editor.sessionId &&
         fieldDescriptorsMatch(session.fieldLock, field));
 }
+const NON_TEXT_INPUT_TYPES = new Set([
+    "button",
+    "checkbox",
+    "color",
+    "file",
+    "hidden",
+    "image",
+    "radio",
+    "range",
+    "reset",
+    "submit",
+]);
+function isHostTextEditor(element) {
+    if (!(element instanceof HTMLElement))
+        return false;
+    if (element instanceof HTMLTextAreaElement)
+        return true;
+    if (element instanceof HTMLInputElement) {
+        return !NON_TEXT_INPUT_TYPES.has(element.type);
+    }
+    return element.isContentEditable;
+}
+/**
+ * Notes whether the user pressed a pointer in the host document (outside the
+ * canvas iframe) and focus is now in a text editor there. Programmatic focus
+ * changes, such as the form focusing the field the canvas click selected, do
+ * not count.
+ */
+function watchHostEditorFocus() {
+    if (typeof document === "undefined") {
+        return { movedToHostEditor: () => false, stop: () => { } };
+    }
+    let pressed = false;
+    const onPointerDown = () => {
+        pressed = true;
+    };
+    document.addEventListener("pointerdown", onPointerDown, true);
+    return {
+        movedToHostEditor: () => pressed && isHostTextEditor(document.activeElement),
+        stop: () => document.removeEventListener("pointerdown", onPointerDown, true),
+    };
+}
 function logBridgeInlineEditDiagnostic(message, details) {
     logFieldValueDiagnostic("bridge-inline", message, details);
 }