@parhelia/core 0.3.12827 → 0.3.12832

package/dist/editor/sidebar/liveComponentThumbnails.js

@@ -0,0 +1,204 @@
+import { useEffect, useRef, useState } from "react";
+import { normalizeBridgeKey } from "../bridge/bridgeKeys";
+import { BRIDGE_DOM_UPDATED_EVENT } from "../page-viewer/MiniMap";
+/** Quiet time after the last host DOM mutation before the page is recaptured. */
+export const LIVE_THUMBNAIL_DEBOUNCE_MS = 1200;
+/** Delay for the first capture after thumbnails are switched on. */
+export const LIVE_THUMBNAIL_INITIAL_DELAY_MS = 300;
+/** Longest canvas side the host renders; thumbnails never need more. */
+export const LIVE_THUMBNAIL_MAX_DIMENSION = 3000;
+export function buildThumbnailSheet(payload, imageUrl) {
+    const rects = new Map();
+    for (const component of payload.components ?? []) {
+        const id = normalizeBridgeKey(component.componentId || component.key);
+        if (!id || rects.has(id))
+            continue;
+        if (component.width <= 0 || component.height <= 0)
+            continue;
+        rects.set(id, {
+            x: component.x,
+            y: component.y,
+            width: component.width,
+            height: component.height,
+        });
+    }
+    return {
+        imageUrl,
+        width: Math.max(1, payload.width ?? 1),
+        height: Math.max(1, payload.height ?? 1),
+        rects,
+    };
+}
+export function findThumbnailRect(sheet, componentId) {
+    return sheet.rects.get(normalizeBridgeKey(componentId)) ?? null;
+}
+/**
+ * CSS that shows exactly one component's crop of the sheet inside a box of the
+ * given size. Always fits the entire component, including tall modules in a
+ * narrow viewport. Clip the shared page image to the component's bounds so
+ * neighboring components cannot show through the unused space.
+ */
+export function getThumbnailBackgroundStyle(sheet, rect, box) {
+    const scale = Math.min(box.width / rect.width, box.height / rect.height, 1);
+    const insetX = Math.max(0, (box.width - rect.width * scale) / 2);
+    const insetY = Math.max(0, (box.height - rect.height * scale) / 2);
+    const offsetX = insetX - rect.x * scale;
+    const offsetY = insetY - rect.y * scale;
+    return {
+        backgroundImage: `url("${sheet.imageUrl}")`,
+        backgroundRepeat: "no-repeat",
+        backgroundSize: `${round(sheet.width * scale)}px ${round(sheet.height * scale)}px`,
+        backgroundPosition: `${round(offsetX)}px ${round(offsetY)}px`,
+        clipPath: `inset(${round(insetY)}px ${round(insetX)}px)`,
+    };
+}
+function round(value) {
+    return Math.round(value * 100) / 100;
+}
+/**
+ * Turns the host's data URL into an object URL so thirty rows reference one
+ * short blob URL instead of each inlining a megabyte of base64 into their
+ * style attribute. Falls back to the data URL where object URLs are missing.
+ */
+export function toThumbnailImageUrl(dataUrl) {
+    if (typeof URL === "undefined" ||
+        typeof URL.createObjectURL !== "function" ||
+        typeof Blob === "undefined") {
+        return dataUrl;
+    }
+    try {
+        const comma = dataUrl.indexOf(",");
+        const header = dataUrl.slice(0, comma);
+        const body = dataUrl.slice(comma + 1);
+        const mimeMatch = /^data:([^;,]+)/.exec(header);
+        const mime = mimeMatch?.[1] ?? "image/png";
+        if (!/;base64$/i.test(header)) {
+            return dataUrl;
+        }
+        const binary = atob(body);
+        const bytes = new Uint8Array(binary.length);
+        for (let i = 0; i < binary.length; i++) {
+            bytes[i] = binary.charCodeAt(i);
+        }
+        return URL.createObjectURL(new Blob([bytes], { type: mime }));
+    }
+    catch {
+        return dataUrl;
+    }
+}
+function revokeThumbnailImageUrl(url) {
+    if (!url || !url.startsWith("blob:"))
+        return;
+    try {
+        URL.revokeObjectURL(url);
+    }
+    catch {
+        // Already revoked or unsupported - nothing to release.
+    }
+}
+/**
+ * Keeps a fresh page sheet while `enabled`: captures shortly after switching
+ * on, then again a little after every burst of host DOM mutations (typing,
+ * inserts, reorders, refreshes). Only one capture runs at a time; changes that
+ * arrive mid-capture queue exactly one follow-up. Returns null until the first
+ * capture lands, or when the bridge is unavailable.
+ */
+export function useLiveComponentThumbnails(pageViewContext, enabled) {
+    const [sheet, setSheet] = useState(null);
+    const sheetRef = useRef(null);
+    const timerRef = useRef(null);
+    const inFlightRef = useRef(false);
+    const dirtyRef = useRef(false);
+    const disposedRef = useRef(false);
+    const contextRef = useRef(pageViewContext);
+    contextRef.current = pageViewContext;
+    const bridgeReady = !!pageViewContext?.bridgeReady;
+    const requestPageSnapshot = pageViewContext?.requestBridgePageSnapshot;
+    const bridgeStructure = pageViewContext?.bridgeStructure;
+    const active = enabled && bridgeReady && !!requestPageSnapshot;
+    useEffect(() => {
+        disposedRef.current = false;
+        return () => {
+            disposedRef.current = true;
+            if (timerRef.current !== null) {
+                window.clearTimeout(timerRef.current);
+                timerRef.current = null;
+            }
+            revokeThumbnailImageUrl(sheetRef.current?.imageUrl);
+            sheetRef.current = null;
+        };
+    }, []);
+    useEffect(() => {
+        if (!active) {
+            if (timerRef.current !== null) {
+                window.clearTimeout(timerRef.current);
+                timerRef.current = null;
+            }
+            dirtyRef.current = false;
+            if (sheetRef.current) {
+                revokeThumbnailImageUrl(sheetRef.current.imageUrl);
+                sheetRef.current = null;
+                setSheet(null);
+            }
+            return;
+        }
+        const capture = async () => {
+            timerRef.current = null;
+            const request = contextRef.current?.requestBridgePageSnapshot;
+            if (!request || !contextRef.current?.bridgeReady)
+                return;
+            if (inFlightRef.current) {
+                dirtyRef.current = true;
+                return;
+            }
+            inFlightRef.current = true;
+            dirtyRef.current = false;
+            try {
+                const payload = await request({
+                    maxDimension: LIVE_THUMBNAIL_MAX_DIMENSION,
+                });
+                if (disposedRef.current)
+                    return;
+                if (payload.dataUrl && !payload.error) {
+                    const next = buildThumbnailSheet(payload, toThumbnailImageUrl(payload.dataUrl));
+                    revokeThumbnailImageUrl(sheetRef.current?.imageUrl);
+                    sheetRef.current = next;
+                    setSheet(next);
+                }
+            }
+            catch {
+                // Keep the previous sheet; the next DOM change retries.
+            }
+            finally {
+                inFlightRef.current = false;
+                if (dirtyRef.current && !disposedRef.current) {
+                    schedule(LIVE_THUMBNAIL_DEBOUNCE_MS);
+                }
+            }
+        };
+        const schedule = (delay) => {
+            if (timerRef.current !== null) {
+                window.clearTimeout(timerRef.current);
+            }
+            timerRef.current = window.setTimeout(() => {
+                void capture();
+            }, delay);
+        };
+        const onDomUpdated = () => schedule(LIVE_THUMBNAIL_DEBOUNCE_MS);
+        window.addEventListener(BRIDGE_DOM_UPDATED_EVENT, onDomUpdated);
+        schedule(sheetRef.current
+            ? LIVE_THUMBNAIL_DEBOUNCE_MS
+            : LIVE_THUMBNAIL_INITIAL_DELAY_MS);
+        return () => {
+            window.removeEventListener(BRIDGE_DOM_UPDATED_EVENT, onDomUpdated);
+            if (timerRef.current !== null) {
+                window.clearTimeout(timerRef.current);
+                timerRef.current = null;
+            }
+        };
+        // A new structure means components were added, removed or reordered; the
+        // effect re-runs and schedules a debounced recapture.
+    }, [active, requestPageSnapshot, bridgeStructure]);
+    return sheet;
+}
+//# sourceMappingURL=liveComponentThumbnails.js.map

package/dist/editor/sidebar/liveComponentThumbnails.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"liveComponentThumbnails.js","sourceRoot":"","sources":["../../../src/editor/sidebar/liveComponentThumbnails.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAsB,MAAM,OAAO,CAAC;AAExE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAuBlE,iFAAiF;AACjF,MAAM,CAAC,MAAM,0BAA0B,GAAG,IAAI,CAAC;AAC/C,oEAAoE;AACpE,MAAM,CAAC,MAAM,+BAA+B,GAAG,GAAG,CAAC;AACnD,wEAAwE;AACxE,MAAM,CAAC,MAAM,4BAA4B,GAAG,IAAI,CAAC;AAEjD,MAAM,UAAU,mBAAmB,CACjC,OAAuC,EACvC,QAAgB;IAEhB,MAAM,KAAK,GAAG,IAAI,GAAG,EAAyB,CAAC;IAC/C,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,UAAU,IAAI,EAAE,EAAE,CAAC;QACjD,MAAM,EAAE,GAAG,kBAAkB,CAAC,SAAS,CAAC,WAAW,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;QACtE,IAAI,CAAC,EAAE,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;YAAE,SAAS;QACnC,IAAI,SAAS,CAAC,KAAK,IAAI,CAAC,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC;YAAE,SAAS;QAC5D,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE;YACZ,CAAC,EAAE,SAAS,CAAC,CAAC;YACd,CAAC,EAAE,SAAS,CAAC,CAAC;YACd,KAAK,EAAE,SAAS,CAAC,KAAK;YACtB,MAAM,EAAE,SAAS,CAAC,MAAM;SACzB,CAAC,CAAC;IACL,CAAC;IACD,OAAO;QACL,QAAQ;QACR,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC;QACtC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;QACxC,KAAK;KACN,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,KAAkC,EAClC,WAAsC;IAEtC,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,IAAI,IAAI,CAAC;AAClE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,KAAkC,EAClC,IAAmB,EACnB,GAAsC;IAEtC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5E,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACjE,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACnE,MAAM,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC;IACxC,MAAM,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC;IACxC,OAAO;QACL,eAAe,EAAE,QAAQ,KAAK,CAAC,QAAQ,IAAI;QAC3C,gBAAgB,EAAE,WAAW;QAC7B,cAAc,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,IAAI;QAClF,kBAAkB,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,OAAO,CAAC,IAAI;QAC7D,QAAQ,EAAE,SAAS,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,KAAK;KACzD,CAAC;AACJ,CAAC;AAED,SAAS,KAAK,CAAC,KAAa;IAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC;AACvC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAe;IACjD,IACE,OAAO,GAAG,KAAK,WAAW;QAC1B,OAAO,GAAG,CAAC,eAAe,KAAK,UAAU;QACzC,OAAO,IAAI,KAAK,WAAW,EAC3B,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACvC,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,IAAI,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC;QAC3C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,GAAG,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,GAA8B;IAC7D,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC;QAAE,OAAO;IAC7C,IAAI,CAAC;QACH,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAAC,MAAM,CAAC;QACP,uDAAuD;IACzD,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CACxC,eAA4C,EAC5C,OAAgB;IAEhB,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAqC,IAAI,CAAC,CAAC;IAC7E,MAAM,QAAQ,GAAG,MAAM,CAAqC,IAAI,CAAC,CAAC;IAClE,MAAM,QAAQ,GAAG,MAAM,CAAgB,IAAI,CAAC,CAAC;IAC7C,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC/B,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAClC,MAAM,UAAU,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;IAC3C,UAAU,CAAC,OAAO,GAAG,eAAe,CAAC;IAErC,MAAM,WAAW,GAAG,CAAC,CAAC,eAAe,EAAE,WAAW,CAAC;IACnD,MAAM,mBAAmB,GAAG,eAAe,EAAE,yBAAyB,CAAC;IACvE,MAAM,eAAe,GAAG,eAAe,EAAE,eAAe,CAAC;IACzD,MAAM,MAAM,GAAG,OAAO,IAAI,WAAW,IAAI,CAAC,CAAC,mBAAmB,CAAC;IAE/D,SAAS,CAAC,GAAG,EAAE;QACb,WAAW,CAAC,OAAO,GAAG,KAAK,CAAC;QAC5B,OAAO,GAAG,EAAE;YACV,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC;YAC3B,IAAI,QAAQ,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;gBAC9B,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBACtC,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;YAC1B,CAAC;YACD,uBAAuB,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YACpD,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;QAC1B,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,QAAQ,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;gBAC9B,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBACtC,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;YAC1B,CAAC;YACD,QAAQ,CAAC,OAAO,GAAG,KAAK,CAAC;YACzB,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;gBACrB,uBAAuB,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACnD,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;gBACxB,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjB,CAAC;YACD,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,IAAI,EAAE;YACzB,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;YACxB,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,yBAAyB,CAAC;YAC9D,IAAI,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,WAAW;gBAAE,OAAO;YACzD,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBACxB,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;gBACxB,OAAO;YACT,CAAC;YACD,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC;YAC3B,QAAQ,CAAC,OAAO,GAAG,KAAK,CAAC;YACzB,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC;oBAC5B,YAAY,EAAE,4BAA4B;iBAC3C,CAAC,CAAC;gBACH,IAAI,WAAW,CAAC,OAAO;oBAAE,OAAO;gBAChC,IAAI,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;oBACtC,MAAM,IAAI,GAAG,mBAAmB,CAC9B,OAAO,EACP,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,CACrC,CAAC;oBACF,uBAAuB,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBACpD,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;oBACxB,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACjB,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,wDAAwD;YAC1D,CAAC;oBAAS,CAAC;gBACT,WAAW,CAAC,OAAO,GAAG,KAAK,CAAC;gBAC5B,IAAI,QAAQ,CAAC,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;oBAC7C,QAAQ,CAAC,0BAA0B,CAAC,CAAC;gBACvC,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAE,EAAE;YACjC,IAAI,QAAQ,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;gBAC9B,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YACxC,CAAC;YACD,QAAQ,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;gBACxC,KAAK,OAAO,EAAE,CAAC;YACjB,CAAC,EAAE,KAAK,CAAC,CAAC;QACZ,CAAC,CAAC;QAEF,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC;QAChE,MAAM,CAAC,gBAAgB,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAC;QAChE,QAAQ,CACN,QAAQ,CAAC,OAAO;YACd,CAAC,CAAC,0BAA0B;YAC5B,CAAC,CAAC,+BAA+B,CACpC,CAAC;QAEF,OAAO,GAAG,EAAE;YACV,MAAM,CAAC,mBAAmB,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAC;YACnE,IAAI,QAAQ,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;gBAC9B,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBACtC,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;YAC1B,CAAC;QACH,CAAC,CAAC;QACF,yEAAyE;QACzE,sDAAsD;IACxD,CAAC,EAAE,CAAC,MAAM,EAAE,mBAAmB,EAAE,eAAe,CAAC,CAAC,CAAC;IAEnD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/editor/ui/PublishReadinessSummary.d.ts

@@ -0,0 +1,12 @@
+import { type PublishReadiness } from "./publishReadiness";
+/**
+ * Explains, above the publish table, which items stay behind and why. Each
+ * item gets an identity line (icon, name, language and version) and a muted
+ * detail line (reason, then what visitors will see) so the banner reads as a
+ * short list instead of one long sentence per item.
+ */
+export declare function PublishReadinessSummary({ readiness, compact, className, }: {
+    readiness: PublishReadiness;
+    compact?: boolean;
+    className?: string;
+}): import("react").JSX.Element | null;

package/dist/editor/ui/PublishReadinessSummary.js

@@ -0,0 +1,34 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { AlertTriangle } from "lucide-react";
+import { Alert, AlertTitle, AlertDescription } from "../../components/ui/alert";
+import { cn } from "../../lib/utils";
+import { getAbsoluteIconUrl } from "../utils";
+import { getPublishReadinessHeadline, getPublishReasonText, getPublishImpactText, } from "./publishReadiness";
+/**
+ * Explains, above the publish table, which items stay behind and why. Each
+ * item gets an identity line (icon, name, language and version) and a muted
+ * detail line (reason, then what visitors will see) so the banner reads as a
+ * short list instead of one long sentence per item.
+ */
+export function PublishReadinessSummary({ readiness, compact = false, className, }) {
+    const headline = getPublishReadinessHeadline(readiness);
+    if (!headline)
+        return null;
+    const page = readiness.currentPage;
+    return (_jsxs(Alert, { variant: page?.blockedByWorkflow ? "destructive" : "warning", "data-testid": "publish-readiness-summary", className: cn(compact && "px-3 py-2 text-xs [&>svg]:top-3 [&>svg]:left-3", className), children: [_jsx(AlertTriangle, { strokeWidth: 1.5, className: "h-4 w-4" }), _jsx(AlertTitle, { "data-testid": "publish-readiness-headline", className: "leading-snug", children: headline }), _jsx(AlertDescription, { className: cn(compact && "text-xs"), children: _jsxs("ul", { className: cn("mt-2 space-y-2", compact && "mt-1 space-y-1.5"), children: [page?.reason && (_jsx(SummaryRow, { testId: "publish-readiness-page", compact: compact, icon: page.item.icon, label: "This page", identity: [page.item.name, identityText(page.item)]
+                                .filter(Boolean)
+                                .join(" · "), reason: getPublishReasonText(page.reason, page.affectedTargets, page.targetCount), impact: page.blockedByWorkflow
+                                ? "Move it to a final workflow state before publishing."
+                                : getPublishImpactText(page.impact, page.validVersion) })), readiness.leftBehind.map((entry) => (_jsx(SummaryRow, { testId: "publish-readiness-item", "data-item-id": entry.item.item.id, "data-category": entry.category, compact: compact, icon: entry.item.icon, label: entry.item.name, identity: identityText(entry.item), reason: entry.reason
+                                ? getPublishReasonText(entry.reason, entry.affectedTargets, entry.targetCount)
+                                : undefined, impact: getPublishImpactText(entry.impact, entry.validVersion) }, entry.key)))] }) })] }));
+}
+function identityText(item) {
+    return [item.item.language, item.item.version ? `v${item.item.version}` : ""]
+        .filter(Boolean)
+        .join(" · ");
+}
+function SummaryRow({ testId, compact, icon, label, identity, reason, impact, ...dataAttributes }) {
+    return (_jsxs("li", { "data-testid": testId, ...dataAttributes, className: cn("flex items-start gap-2", compact && "gap-1.5"), children: [!compact && (_jsx("span", { className: "flex h-5 w-4 shrink-0 items-center justify-center", children: icon && (_jsx("img", { src: getAbsoluteIconUrl(icon, 16), alt: "", className: "h-4 w-4" })) })), _jsxs("span", { className: "min-w-0 flex-1", children: [_jsxs("span", { className: "text-neutral-grey-100 block leading-5 font-medium", children: [label, identity && (_jsx("span", { className: cn("text-neutral-grey-50 ml-1.5 font-normal", compact ? "text-2xs" : "text-xs"), "data-testid": `${testId}-identity`, children: identity }))] }), _jsx("span", { className: cn("text-neutral-grey-50 block leading-snug", compact ? "text-2xs" : "text-xs"), "data-testid": `${testId}-details`, children: [reason, impact].filter(Boolean).join(" ") })] })] }));
+}
+//# sourceMappingURL=PublishReadinessSummary.js.map

package/dist/editor/ui/PublishReadinessSummary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PublishReadinessSummary.js","sourceRoot":"","sources":["../../../src/editor/ui/PublishReadinessSummary.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAChF,OAAO,EAAE,EAAE,EAAE,MAAM,iBAAiB,CAAC;AACrC,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAEL,2BAA2B,EAC3B,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,oBAAoB,CAAC;AAE5B;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,EACtC,SAAS,EACT,OAAO,GAAG,KAAK,EACf,SAAS,GAKV;IACC,MAAM,QAAQ,GAAG,2BAA2B,CAAC,SAAS,CAAC,CAAC;IACxD,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAC;IAC3B,MAAM,IAAI,GAAG,SAAS,CAAC,WAAW,CAAC;IACnC,OAAO,CACL,MAAC,KAAK,IACJ,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,iBAChD,2BAA2B,EACvC,SAAS,EAAE,EAAE,CACX,OAAO,IAAI,gDAAgD,EAC3D,SAAS,CACV,aAED,KAAC,aAAa,IAAC,WAAW,EAAE,GAAG,EAAE,SAAS,EAAC,SAAS,GAAG,EACvD,KAAC,UAAU,mBACG,4BAA4B,EACxC,SAAS,EAAC,cAAc,YAEvB,QAAQ,GACE,EACb,KAAC,gBAAgB,IAAC,SAAS,EAAE,EAAE,CAAC,OAAO,IAAI,SAAS,CAAC,YACnD,cAAI,SAAS,EAAE,EAAE,CAAC,gBAAgB,EAAE,OAAO,IAAI,kBAAkB,CAAC,aAC/D,IAAI,EAAE,MAAM,IAAI,CACf,KAAC,UAAU,IACT,MAAM,EAAC,wBAAwB,EAC/B,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EACpB,KAAK,EAAC,WAAW,EACjB,QAAQ,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iCAChD,MAAM,CAAC,OAAO,CAAC;iCACf,IAAI,CAAC,KAAK,CAAC,EACd,MAAM,EAAE,oBAAoB,CAC1B,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,WAAW,CACjB,EACD,MAAM,EACJ,IAAI,CAAC,iBAAiB;gCACpB,CAAC,CAAC,sDAAsD;gCACxD,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,GAE1D,CACH,EACA,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CACnC,KAAC,UAAU,IAET,MAAM,EAAC,wBAAwB,kBACjB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,mBACjB,KAAK,CAAC,QAAQ,EAC7B,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,EACrB,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,EACtB,QAAQ,EAAE,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAClC,MAAM,EACJ,KAAK,CAAC,MAAM;gCACV,CAAC,CAAC,oBAAoB,CAClB,KAAK,CAAC,MAAM,EACZ,KAAK,CAAC,eAAe,EACrB,KAAK,CAAC,WAAW,CAClB;gCACH,CAAC,CAAC,SAAS,EAEf,MAAM,EAAE,oBAAoB,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,IAjBzD,KAAK,CAAC,GAAG,CAkBd,CACH,CAAC,IACC,GACY,IACb,CACT,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,IAErB;IACC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC1E,MAAM,CAAC,OAAO,CAAC;SACf,IAAI,CAAC,KAAK,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,UAAU,CAAC,EAClB,MAAM,EACN,OAAO,EACP,IAAI,EACJ,KAAK,EACL,QAAQ,EACR,MAAM,EACN,MAAM,EACN,GAAG,cAAc,EAWlB;IACC,OAAO,CACL,6BACe,MAAM,KACf,cAAc,EAClB,SAAS,EAAE,EAAE,CAAC,wBAAwB,EAAE,OAAO,IAAI,SAAS,CAAC,aAE5D,CAAC,OAAO,IAAI,CACX,eAAM,SAAS,EAAC,mDAAmD,YAChE,IAAI,IAAI,CACP,cACE,GAAG,EAAE,kBAAkB,CAAC,IAAI,EAAE,EAAE,CAAC,EACjC,GAAG,EAAC,EAAE,EACN,SAAS,EAAC,SAAS,GACnB,CACH,GACI,CACR,EACD,gBAAM,SAAS,EAAC,gBAAgB,aAC9B,gBAAM,SAAS,EAAC,mDAAmD,aAChE,KAAK,EACL,QAAQ,IAAI,CACX,eACE,SAAS,EAAE,EAAE,CACX,yCAAyC,EACzC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CACjC,iBACY,GAAG,MAAM,WAAW,YAEhC,QAAQ,GACJ,CACR,IACI,EACP,eACE,SAAS,EAAE,EAAE,CACX,yCAAyC,EACzC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CACjC,iBACY,GAAG,MAAM,UAAU,YAE/B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GACtC,IACF,IACJ,CACN,CAAC;AACJ,CAAC"}

package/dist/editor/ui/publishReadiness.d.ts

@@ -0,0 +1,98 @@
+import type { ItemDescriptor, ValidationResult, WorkboxItem } from "../../types";
+export type PublishStatusOutcome = "published" | "pending" | "will-not-publish" | "unknown";
+export type PublishImpact = "none" | "never-published" | "stale" | "other-version" | "unknown";
+export type PublishBlockReason = {
+    kind: "workflow";
+    workflowState: string;
+} | {
+    kind: "no-valid-version";
+} | {
+    kind: "not-valid-version";
+    validVersion?: number;
+};
+export type PublishReadinessCategory = "will-publish" | "already-published" | "covered-by-subitems" | "blocked-by-workflow" | "will-not-publish";
+export type PublishReadinessEntry = {
+    item: WorkboxItem;
+    key: string;
+    category: PublishReadinessCategory;
+    inBatch: boolean;
+    reason?: PublishBlockReason;
+    impact: PublishImpact;
+    affectedTargets: string[];
+    targetCount: number;
+    validVersion?: number;
+};
+export type CurrentPageReadiness = {
+    item: WorkboxItem;
+    blockedByWorkflow: boolean;
+    reason?: PublishBlockReason;
+    impact: PublishImpact;
+    affectedTargets: string[];
+    targetCount: number;
+    validVersion?: number;
+};
+export type PublishReadiness = {
+    currentPage?: CurrentPageReadiness;
+    entries: PublishReadinessEntry[];
+    batchDescriptors: ItemDescriptor[];
+    leftBehind: PublishReadinessEntry[];
+};
+export declare function isReadyToPublish(item: WorkboxItem): boolean;
+export declare function classifyPublishStatus(status: string): {
+    outcome: PublishStatusOutcome;
+    impact: PublishImpact;
+    validVersion?: number;
+};
+export type PublishStatusDescription = {
+    /** Short badge text, e.g. "Not yet published". */
+    label: string;
+    /** Optional explanation for a tooltip: published version, revision, name or valid version. */
+    detail?: string;
+};
+/**
+ * Turns a canonical Sitecore publish status into a short badge label plus an
+ * optional detail line, so the table stays scannable and the specifics
+ * (published revision, currently published version, valid version, published
+ * name) move into a tooltip. Unknown statuses are shown verbatim.
+ */
+export declare function describePublishStatus(status: string): PublishStatusDescription;
+/**
+ * Compares descriptors the way the workbox does: ids without braces and
+ * case-insensitive, languages case-insensitive. A version of 0/undefined means
+ * "latest" (the editor keeps the *requested* descriptor when an item is opened
+ * from the tree) and matches any concrete version of that item.
+ */
+export declare function isSameDescriptor(a: ItemDescriptor, b: ItemDescriptor): boolean;
+/** The workbox row for the item currently open in the editor, if listed. */
+export declare function findCurrentWorkboxItem(workboxItems: WorkboxItem[], currentItem: ItemDescriptor | undefined): WorkboxItem | undefined;
+/**
+ * Display order for the Publish dialog: the current item stays first, then the
+ * related items grouped by template name and ordered by item path, so media,
+ * layouts and datasources cluster together instead of following the link
+ * database's order. Returns a new array; the input is left untouched.
+ */
+export declare function sortWorkboxItemsForPublish(workboxItems: WorkboxItem[], currentItem: ItemDescriptor | undefined): WorkboxItem[];
+export type PublishValidationSummary = {
+    /** Listed workbox items that carry at least one validation result. */
+    itemCount: number;
+    /** All validation results across those items. */
+    issueCount: number;
+};
+/**
+ * Counts the validation issues that affect the listed workbox items. The
+ * server only reports failing validators, so every result is an issue; a
+ * page's entry also carries results for its embedded components, which are
+ * counted with the page.
+ */
+export declare function getPublishValidationSummary(workboxItems: WorkboxItem[], validationResults: ValidationResult[] | undefined): PublishValidationSummary;
+/** True when `path` lies strictly below `rootPath` (Sitecore paths are case-insensitive). */
+export declare function isDescendantPath(path?: string, rootPath?: string): boolean;
+export declare function getPublishReadiness({ workboxItems, currentItem, pagePath, includeSubitems, }: {
+    workboxItems: WorkboxItem[];
+    currentItem: ItemDescriptor | undefined;
+    pagePath: string | undefined;
+    includeSubitems: boolean;
+}): PublishReadiness;
+export declare function getPublishReasonText(reason: PublishBlockReason, affectedTargets: string[], targetCount: number): string;
+export declare function getPublishImpactText(impact: PublishImpact, validVersion?: number): string | undefined;
+export declare function getPublishReadinessHeadline(readiness: PublishReadiness): string | undefined;