@preprio/toolkit 0.4.2 → 0.5.0-rc.1

package/dist/react/components.js

@@ -267,6 +267,7 @@ function createElementCache(query, ttl = 1e3) {
 }
 
 // src/core/iframe-bridge.ts
+var debug = createScopedLogger("iframe-bridge");
 var EDITOR_BASE_DOMAIN = "prepr.io";
 function isAllowedEditorOrigin(origin, allowed) {
   if (allowed) return allowed.includes(origin);
@@ -284,6 +285,7 @@ function isAllowedEditorOrigin(origin, allowed) {
 }
 function createIframeBridge(store, options = {}) {
   const allowedOrigins = options.allowedEditorOrigins;
+  const onScrollToField = options.onScrollToField;
   let parentOrigin = null;
   const onKeyDown = (event) => {
     const key = event.key.toLowerCase();
@@ -307,6 +309,15 @@ function createIframeBridge(store, options = {}) {
       const currentScrollY = window.scrollY || document.documentElement.scrollTop;
       sendPreprEvent("getScrollPosition", { value: currentScrollY });
     }
+    if (data?.event === "prepr:scrollToField") {
+      if (typeof data.field !== "string" || !data.field) return;
+      if (data.id !== void 0 && typeof data.id !== "string") return;
+      try {
+        onScrollToField?.({ field: data.field, id: data.id });
+      } catch (error) {
+        debug.warn("scrollToField handler failed", error);
+      }
+    }
   };
   return {
     start() {
@@ -331,7 +342,7 @@ import { vercelStegaSplit } from "@vercel/stega";
 
 // src/core/stega/clean.ts
 import { vercelStegaClean, vercelStegaDecode } from "@vercel/stega";
-var debug = createScopedLogger("stega:clean");
+var debug2 = createScopedLogger("stega:clean");
 function decodeStega(str) {
   if (!str) return null;
   try {
@@ -340,7 +351,7 @@ function decodeStega(str) {
       return decoded;
     }
   } catch (error) {
-    debug.log("error decoding stega data", error);
+    debug2.log("error decoding stega data", error);
     const match = str.match(/{"origin.*?}/);
     if (match) {
       try {
@@ -349,7 +360,7 @@ function decodeStega(str) {
           return decodedMatch;
         }
       } catch (innerError) {
-        debug.log("error decoding stega regex match", innerError);
+        debug2.log("error decoding stega regex match", innerError);
       }
     }
   }
@@ -385,14 +396,37 @@ function isRenderedElement(element) {
   if (!style) return true;
   return style.visibility !== "hidden" && style.display !== "none";
 }
+function parseEditHref(href) {
+  try {
+    const url = new URL(href, window.location.origin);
+    return {
+      id: url.pathname.split("/").pop() || void 0,
+      field: url.searchParams.get("field") || void 0,
+      locale: url.searchParams.get("locale") || void 0
+    };
+  } catch {
+    return {};
+  }
+}
+function setOrRemove(element, name, value) {
+  if (value) {
+    element.setAttribute(name, value);
+  } else {
+    element.removeAttribute(name);
+  }
+}
 function tagEncodedElement(element, decoded) {
   element.setAttribute("data-prepr-encoded", "");
   element.setAttribute("data-prepr-href", decoded.href);
   element.setAttribute("data-prepr-origin", decoded.origin);
+  const { id, field, locale } = parseEditHref(decoded.href);
+  setOrRemove(element, "data-prepr-id", id);
+  setOrRemove(element, "data-prepr-field", field);
+  setOrRemove(element, "data-prepr-locale", locale);
 }
 
 // src/core/stega/auto-clean.ts
-var debug2 = createScopedLogger("stega:auto-clean");
+var debug3 = createScopedLogger("stega:auto-clean");
 function createStegaAutoClean(options) {
   const stripText = options?.enabled ?? true;
   let observer = null;
@@ -435,7 +469,7 @@ function createStegaAutoClean(options) {
       }
       pendingHidden.add(textNode);
     } catch (error) {
-      debug2.log("error cleaning text node", error);
+      debug3.log("error cleaning text node", error);
     }
     return false;
   }
@@ -521,7 +555,7 @@ function createStegaAutoClean(options) {
     if (observer || typeof window === "undefined") return;
     scanAndClean();
     setupObserver();
-    debug2.log("stega auto-clean started");
+    debug3.log("stega auto-clean started");
   }
   function stop() {
     if (debounceTimeout) {
@@ -535,13 +569,13 @@ function createStegaAutoClean(options) {
     cleaned = /* @__PURE__ */ new WeakMap();
     pendingHidden = /* @__PURE__ */ new Set();
     pendingDirty = /* @__PURE__ */ new Set();
-    debug2.log("stega auto-clean stopped");
+    debug3.log("stega auto-clean stopped");
   }
   return { start, stop };
 }
 
 // src/core/stega/elements.ts
-var debug3 = createScopedLogger("stega:elements");
+var debug4 = createScopedLogger("stega:elements");
 var StegaElements = class {
   constructor(decode = decodeStega) {
     this.observer = null;
@@ -586,7 +620,7 @@ var StegaElements = class {
     walkTextNodes(document.body, (textNode) => {
       if (this.tagFromTextNode(textNode)) encodedCount++;
     });
-    debug3.log("document scan complete, encoded", encodedCount, "elements");
+    debug4.log("document scan complete, encoded", encodedCount, "elements");
     this.elements = document.querySelectorAll("[data-prepr-encoded]");
   }
   /** `onUpdate` fires after each debounced batch, for refreshing derived state. */
@@ -642,6 +676,9 @@ var StegaElements = class {
       element.removeAttribute("data-prepr-encoded");
       element.removeAttribute("data-prepr-href");
       element.removeAttribute("data-prepr-origin");
+      element.removeAttribute("data-prepr-id");
+      element.removeAttribute("data-prepr-field");
+      element.removeAttribute("data-prepr-locale");
       element.classList.remove("prepr-overlay-active");
     });
     this.elements = void 0;
@@ -649,7 +686,7 @@ var StegaElements = class {
 };
 
 // src/core/stega/overlay.ts
-var debug4 = createScopedLogger("stega:overlay");
+var debug5 = createScopedLogger("stega:overlay");
 var StegaOverlay = class {
   constructor(onEdit) {
     this.overlay = null;
@@ -694,7 +731,8 @@ var StegaOverlay = class {
     const origin = element.getAttribute("data-prepr-origin");
     const id = element.getAttribute("data-prepr-id") ?? void 0;
     const field = element.getAttribute("data-prepr-field") ?? void 0;
-    debug4.log("showing overlay", { href, origin });
+    const locale = element.getAttribute("data-prepr-locale") ?? void 0;
+    debug5.log("showing overlay", { href, origin });
     const overlay = this.overlay;
     overlay.style.display = "block";
     overlay.style.top = `${rect.top + window.scrollY - 2}px`;
@@ -726,7 +764,7 @@ var StegaOverlay = class {
         tooltip.style.left = `${left}px`;
       });
       tooltip.onclick = () => {
-        this.onEdit({ href, origin, id, field });
+        this.onEdit({ href, origin, id, field, locale });
       };
     }
     this.currentElement = element;
@@ -766,7 +804,7 @@ var StegaOverlay = class {
 };
 
 // src/core/stega/proximity.ts
-var debug5 = createScopedLogger("stega:proximity");
+var debug6 = createScopedLogger("stega:proximity");
 var StegaProximity = class {
   constructor() {
     this.highlighted = /* @__PURE__ */ new Set();
@@ -801,9 +839,9 @@ var StegaProximity = class {
       );
       const nodes = this.getEncodedElements();
       nodes.forEach((el) => this.observer.observe(el));
-      debug5.log("observing", nodes.length, "encoded elements");
+      debug6.log("observing", nodes.length, "encoded elements");
     } catch (error) {
-      debug5.log("error setting up IntersectionObserver", error);
+      debug6.log("error setting up IntersectionObserver", error);
     }
   }
   stopObserving() {
@@ -873,7 +911,7 @@ function removeStegaStyles() {
 }
 
 // src/core/stega/scan.ts
-var debug6 = createScopedLogger("stega:scan");
+var debug7 = createScopedLogger("stega:scan");
 var EDITOR_MODE_STYLES = "[data-prepr-encoded]{cursor:pointer}";
 function createStegaController(opts) {
   const tooltipEnabled = opts.tooltip ?? true;
@@ -906,12 +944,13 @@ function createStegaController(opts) {
       href: encoded.getAttribute("data-prepr-href") ?? "",
       origin: encoded.getAttribute("data-prepr-origin") ?? "",
       id: encoded.getAttribute("data-prepr-id") ?? void 0,
-      field: encoded.getAttribute("data-prepr-field") ?? void 0
+      field: encoded.getAttribute("data-prepr-field") ?? void 0,
+      locale: encoded.getAttribute("data-prepr-locale") ?? void 0
     });
   };
   const start = () => {
     if (initialized) {
-      debug6.log("already initialized, skipping setup");
+      debug7.log("already initialized, skipping setup");
       return;
     }
     if (!tooltipEnabled) {
@@ -921,7 +960,7 @@ function createStegaController(opts) {
       });
       document.addEventListener("click", handleClick, { capture: true });
       initialized = true;
-      debug6.log("stega controller started (editor mode)");
+      debug7.log("stega controller started (editor mode)");
       return;
     }
     injectStegaStyles();
@@ -952,7 +991,7 @@ function createStegaController(opts) {
       passive: true
     });
     initialized = true;
-    debug6.log("stega controller started");
+    debug7.log("stega controller started");
   };
   const stop = () => {
     if (!initialized) return;
@@ -961,7 +1000,7 @@ function createStegaController(opts) {
       elements.cleanup();
       removeStegaStyles();
       initialized = false;
-      debug6.log("stega controller stopped (editor mode)");
+      debug7.log("stega controller stopped (editor mode)");
       return;
     }
     if (throttledMouseMove) {
@@ -981,11 +1020,43 @@ function createStegaController(opts) {
     elements.cleanup();
     removeStegaStyles();
     initialized = false;
-    debug6.log("stega controller stopped");
+    debug7.log("stega controller stopped");
   };
   return { start, stop };
 }
 
+// src/core/stega/scroll-to-field.ts
+var debug8 = createScopedLogger("stega:scroll");
+var FLASH_DURATION_MS = 1200;
+var flashTimeout = null;
+function scrollToField(request) {
+  const { field, id } = request;
+  if (!field) return false;
+  const candidates = document.querySelectorAll(
+    "[data-prepr-encoded]"
+  );
+  let target = null;
+  for (const candidate of candidates) {
+    if (candidate.getAttribute("data-prepr-field") !== field) continue;
+    if (id && candidate.getAttribute("data-prepr-id") !== id) continue;
+    target = candidate;
+    break;
+  }
+  if (!target) {
+    debug8.log("no element found for field", field);
+    return false;
+  }
+  target.scrollIntoView({ behavior: "smooth", block: "center" });
+  if (flashTimeout) clearTimeout(flashTimeout);
+  document.querySelectorAll(".prepr-overlay-active").forEach((el) => el.classList.remove("prepr-overlay-active"));
+  target.classList.add("prepr-overlay-active");
+  flashTimeout = setTimeout(() => {
+    target.classList.remove("prepr-overlay-active");
+    flashTimeout = null;
+  }, FLASH_DURATION_MS);
+  return true;
+}
+
 // src/core/store.ts
 var DEFAULT_STATE = {
   locale: "en",
@@ -2098,7 +2169,7 @@ function definePreprToolbar() {
 }
 
 // src/core/create-preview.ts
-var debug7 = createScopedLogger("create-preview");
+var debug9 = createScopedLogger("create-preview");
 var controllerStores = /* @__PURE__ */ new WeakMap();
 function defaultNavigation() {
   return {
@@ -2140,7 +2211,7 @@ function createPreprPreview(opts = {}) {
   const search = new URLSearchParams(window.location.search);
   const hideBar = search.get(PARAM_HIDE_BAR) === "true";
   if (hideBar) {
-    debug7.log(`${PARAM_HIDE_BAR}=true \u2014 no visible toolbar`);
+    debug9.log(`${PARAM_HIDE_BAR}=true \u2014 no visible toolbar`);
   }
   const mountUi = (options?.ui ?? true) && !isIframe && !hideBar;
   const locale = resolveLocale(options);
@@ -2176,18 +2247,17 @@ function createPreprPreview(opts = {}) {
     tooltip: mountUi,
     // In the editor, ask the parent to focus the field instead of opening a new
     // tab. Standalone previews keep the window.open behaviour.
-    onEdit: ({ href, origin, id, field }) => {
+    onEdit: ({ href, id, field, locale: contentLocale }) => {
       const safeHref = href ? safeEditUrl(href) : null;
       if (href && !safeHref) {
-        debug7.warn("ignored edit request with unsupported href scheme");
+        debug9.warn("ignored edit request with unsupported href scheme");
         return;
       }
       if (isIframe) {
         sendPreprEvent("field_edit_requested", {
-          href: safeHref ?? void 0,
-          origin,
           id,
-          field
+          field,
+          locale: contentLocale
         });
       } else if (safeHref) {
         window.open(safeHref, "_blank", "noopener,noreferrer");
@@ -2214,7 +2284,15 @@ function createPreprPreview(opts = {}) {
     handleChange(before, state);
   });
   const bridge = createIframeBridge(store, {
-    allowedEditorOrigins: options?.allowedEditorOrigins
+    allowedEditorOrigins: options?.allowedEditorOrigins,
+    // The editor selecting a field scrolls the matching element into view. The
+    // lookup relies on the attributes the stega scan writes, so it finds
+    // nothing until encoded content has been tagged.
+    onScrollToField: ({ field, id }) => {
+      if (!scrollToField({ field, id })) {
+        debug9.log("no element on this page renders field", field);
+      }
+    }
   });
   sendPreprEvent(
     "getScrollPosition",
@@ -2234,7 +2312,7 @@ function createPreprPreview(opts = {}) {
       bridge.stop();
     }
     el?.remove();
-    debug7.log("preview destroyed");
+    debug9.log("preview destroyed");
   }
   const controller = { destroy };
   controllerStores.set(controller, store);
@@ -2242,7 +2320,7 @@ function createPreprPreview(opts = {}) {
 }
 
 // src/version.ts
-var VERSION = "0.4.2";
+var VERSION = "0.5.0-rc.1";
 
 // src/core/pixel.ts
 var PIXEL_SCRIPT_URL = "https://cdn.tracking.prepr.io/js/prepr.min.js";

package/dist/sveltekit/index.cjs

@@ -35,7 +35,7 @@ __export(sveltekit_exports, {
 module.exports = __toCommonJS(sveltekit_exports);
 
 // src/version.ts
-var VERSION = "0.4.2";
+var VERSION = "0.5.0-rc.1";
 
 // src/core/constants.ts
 var COOKIE_PREVIEW_MODE = "Prepr-Preview-Mode";
@@ -144,7 +144,7 @@ function processFrameworkRequest(request, opts, framework) {
   }
   const userAgent = request.headers.get("user-agent");
   if (userAgent) {
-    requestHeaders.set("Prepr-User-Agent", sanitizeHeaderValue(userAgent));
+    requestHeaders.set("User-Agent", sanitizeHeaderValue(userAgent));
   }
   const packageParts = [`@preprio/toolkit@${opts?.version ?? VERSION}`];
   if (framework) packageParts.push(`framework=${framework}`);
@@ -292,7 +292,7 @@ var PREPR_HEADER_KEYS = [
   "Prepr-Visitor-IP",
   "Prepr-Hubspot-Id",
   "Prepr-Customer-Id-Created",
-  "Prepr-User-Agent",
+  "User-Agent",
   "Prepr-Package"
 ];
 function getPreprHeadersFromHeaders(headers) {

package/dist/sveltekit/index.d.cts

@@ -59,6 +59,9 @@ interface PreprHeaders {
     readonly 'Prepr-Visitor-IP'?: string;
     readonly 'Prepr-Hubspot-Id'?: string;
     readonly 'Prepr-Customer-Id-Created'?: 'true';
+    /** The visitor's browser User-Agent, used by the API for device detection. */
+    readonly 'User-Agent'?: string;
+    /** @deprecated Never populated; the visitor's value is under `User-Agent`. */
     readonly 'Prepr-User-Agent'?: string;
     readonly 'Prepr-Package'?: string;
 }

package/dist/sveltekit/index.d.ts

@@ -59,6 +59,9 @@ interface PreprHeaders {
     readonly 'Prepr-Visitor-IP'?: string;
     readonly 'Prepr-Hubspot-Id'?: string;
     readonly 'Prepr-Customer-Id-Created'?: 'true';
+    /** The visitor's browser User-Agent, used by the API for device detection. */
+    readonly 'User-Agent'?: string;
+    /** @deprecated Never populated; the visitor's value is under `User-Agent`. */
     readonly 'Prepr-User-Agent'?: string;
     readonly 'Prepr-Package'?: string;
 }

package/dist/sveltekit/index.js

@@ -1,5 +1,5 @@
 // src/version.ts
-var VERSION = "0.4.2";
+var VERSION = "0.5.0-rc.1";
 
 // src/core/constants.ts
 var COOKIE_PREVIEW_MODE = "Prepr-Preview-Mode";
@@ -108,7 +108,7 @@ function processFrameworkRequest(request, opts, framework) {
   }
   const userAgent = request.headers.get("user-agent");
   if (userAgent) {
-    requestHeaders.set("Prepr-User-Agent", sanitizeHeaderValue(userAgent));
+    requestHeaders.set("User-Agent", sanitizeHeaderValue(userAgent));
   }
   const packageParts = [`@preprio/toolkit@${opts?.version ?? VERSION}`];
   if (framework) packageParts.push(`framework=${framework}`);
@@ -256,7 +256,7 @@ var PREPR_HEADER_KEYS = [
   "Prepr-Visitor-IP",
   "Prepr-Hubspot-Id",
   "Prepr-Customer-Id-Created",
-  "Prepr-User-Agent",
+  "User-Agent",
   "Prepr-Package"
 ];
 function getPreprHeadersFromHeaders(headers) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@preprio/toolkit",
-  "version": "0.4.2",
+  "version": "0.5.0-rc.1",
   "description": "Prepr personalization, A/B testing and preview toolkit for React, Next.js, Nuxt, Astro, SvelteKit and Express",
   "license": "Apache-2.0",
   "author": "Prepr B.V. (https://prepr.io)",