@preprio/toolkit 0.5.0-rc.1 → 0.6.0-alpha.0

package/dist/react/components.js

@@ -267,7 +267,6 @@ 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);
@@ -285,7 +284,6 @@ 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();
@@ -309,15 +307,6 @@ 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() {
@@ -342,7 +331,7 @@ import { vercelStegaSplit } from "@vercel/stega";
 
 // src/core/stega/clean.ts
 import { vercelStegaClean, vercelStegaDecode } from "@vercel/stega";
-var debug2 = createScopedLogger("stega:clean");
+var debug = createScopedLogger("stega:clean");
 function decodeStega(str) {
   if (!str) return null;
   try {
@@ -351,7 +340,7 @@ function decodeStega(str) {
       return decoded;
     }
   } catch (error) {
-    debug2.log("error decoding stega data", error);
+    debug.log("error decoding stega data", error);
     const match = str.match(/{"origin.*?}/);
     if (match) {
       try {
@@ -360,7 +349,7 @@ function decodeStega(str) {
           return decodedMatch;
         }
       } catch (innerError) {
-        debug2.log("error decoding stega regex match", innerError);
+        debug.log("error decoding stega regex match", innerError);
       }
     }
   }
@@ -396,37 +385,15 @@ 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 debug3 = createScopedLogger("stega:auto-clean");
+var debug2 = createScopedLogger("stega:auto-clean");
+var HYDRATION_RETRY_MS = 100;
 function createStegaAutoClean(options) {
   const stripText = options?.enabled ?? true;
   let observer = null;
@@ -435,8 +402,29 @@ function createStegaAutoClean(options) {
   let pendingHidden = /* @__PURE__ */ new Set();
   let pendingDirty = /* @__PURE__ */ new Set();
   let debounceTimeout = null;
+  const isHydrated = options?.isHydrated;
+  let pendingHydration = /* @__PURE__ */ new Set();
+  let hydrationTimeout = null;
+  function retryPendingHydration() {
+    hydrationTimeout = null;
+    processing = true;
+    const batch = [...pendingHydration];
+    pendingHydration.clear();
+    batch.forEach((textNode) => {
+      if (textNode.isConnected) cleanTextNode(textNode);
+    });
+    processing = false;
+  }
   function cleanTextNode(textNode) {
     if (isIgnoredTextNode(textNode)) return false;
+    if (isHydrated && !isHydrated(textNode)) {
+      pendingHydration.add(textNode);
+      hydrationTimeout ?? (hydrationTimeout = setTimeout(
+        retryPendingHydration,
+        HYDRATION_RETRY_MS
+      ));
+      return false;
+    }
     const textContent = textNode.textContent;
     const info = cleaned.get(textNode);
     const settled = stripText ? info?.cleaned : info?.original;
@@ -469,7 +457,7 @@ function createStegaAutoClean(options) {
       }
       pendingHidden.add(textNode);
     } catch (error) {
-      debug3.log("error cleaning text node", error);
+      debug2.log("error cleaning text node", error);
     }
     return false;
   }
@@ -555,13 +543,17 @@ function createStegaAutoClean(options) {
     if (observer || typeof window === "undefined") return;
     scanAndClean();
     setupObserver();
-    debug3.log("stega auto-clean started");
+    debug2.log("stega auto-clean started");
   }
   function stop() {
     if (debounceTimeout) {
       clearTimeout(debounceTimeout);
       debounceTimeout = null;
     }
+    if (hydrationTimeout) {
+      clearTimeout(hydrationTimeout);
+      hydrationTimeout = null;
+    }
     if (observer) {
       observer.disconnect();
       observer = null;
@@ -569,13 +561,14 @@ function createStegaAutoClean(options) {
     cleaned = /* @__PURE__ */ new WeakMap();
     pendingHidden = /* @__PURE__ */ new Set();
     pendingDirty = /* @__PURE__ */ new Set();
-    debug3.log("stega auto-clean stopped");
+    pendingHydration = /* @__PURE__ */ new Set();
+    debug2.log("stega auto-clean stopped");
   }
   return { start, stop };
 }
 
 // src/core/stega/elements.ts
-var debug4 = createScopedLogger("stega:elements");
+var debug3 = createScopedLogger("stega:elements");
 var StegaElements = class {
   constructor(decode = decodeStega) {
     this.observer = null;
@@ -620,7 +613,7 @@ var StegaElements = class {
     walkTextNodes(document.body, (textNode) => {
       if (this.tagFromTextNode(textNode)) encodedCount++;
     });
-    debug4.log("document scan complete, encoded", encodedCount, "elements");
+    debug3.log("document scan complete, encoded", encodedCount, "elements");
     this.elements = document.querySelectorAll("[data-prepr-encoded]");
   }
   /** `onUpdate` fires after each debounced batch, for refreshing derived state. */
@@ -676,9 +669,6 @@ 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;
@@ -686,7 +676,7 @@ var StegaElements = class {
 };
 
 // src/core/stega/overlay.ts
-var debug5 = createScopedLogger("stega:overlay");
+var debug4 = createScopedLogger("stega:overlay");
 var StegaOverlay = class {
   constructor(onEdit) {
     this.overlay = null;
@@ -731,8 +721,7 @@ 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;
-    const locale = element.getAttribute("data-prepr-locale") ?? void 0;
-    debug5.log("showing overlay", { href, origin });
+    debug4.log("showing overlay", { href, origin });
     const overlay = this.overlay;
     overlay.style.display = "block";
     overlay.style.top = `${rect.top + window.scrollY - 2}px`;
@@ -764,7 +753,7 @@ var StegaOverlay = class {
         tooltip.style.left = `${left}px`;
       });
       tooltip.onclick = () => {
-        this.onEdit({ href, origin, id, field, locale });
+        this.onEdit({ href, origin, id, field });
       };
     }
     this.currentElement = element;
@@ -804,7 +793,7 @@ var StegaOverlay = class {
 };
 
 // src/core/stega/proximity.ts
-var debug6 = createScopedLogger("stega:proximity");
+var debug5 = createScopedLogger("stega:proximity");
 var StegaProximity = class {
   constructor() {
     this.highlighted = /* @__PURE__ */ new Set();
@@ -839,9 +828,9 @@ var StegaProximity = class {
       );
       const nodes = this.getEncodedElements();
       nodes.forEach((el) => this.observer.observe(el));
-      debug6.log("observing", nodes.length, "encoded elements");
+      debug5.log("observing", nodes.length, "encoded elements");
     } catch (error) {
-      debug6.log("error setting up IntersectionObserver", error);
+      debug5.log("error setting up IntersectionObserver", error);
     }
   }
   stopObserving() {
@@ -911,7 +900,7 @@ function removeStegaStyles() {
 }
 
 // src/core/stega/scan.ts
-var debug7 = createScopedLogger("stega:scan");
+var debug6 = createScopedLogger("stega:scan");
 var EDITOR_MODE_STYLES = "[data-prepr-encoded]{cursor:pointer}";
 function createStegaController(opts) {
   const tooltipEnabled = opts.tooltip ?? true;
@@ -944,13 +933,12 @@ 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,
-      locale: encoded.getAttribute("data-prepr-locale") ?? void 0
+      field: encoded.getAttribute("data-prepr-field") ?? void 0
     });
   };
   const start = () => {
     if (initialized) {
-      debug7.log("already initialized, skipping setup");
+      debug6.log("already initialized, skipping setup");
       return;
     }
     if (!tooltipEnabled) {
@@ -960,7 +948,7 @@ function createStegaController(opts) {
       });
       document.addEventListener("click", handleClick, { capture: true });
       initialized = true;
-      debug7.log("stega controller started (editor mode)");
+      debug6.log("stega controller started (editor mode)");
       return;
     }
     injectStegaStyles();
@@ -991,7 +979,7 @@ function createStegaController(opts) {
       passive: true
     });
     initialized = true;
-    debug7.log("stega controller started");
+    debug6.log("stega controller started");
   };
   const stop = () => {
     if (!initialized) return;
@@ -1000,7 +988,7 @@ function createStegaController(opts) {
       elements.cleanup();
       removeStegaStyles();
       initialized = false;
-      debug7.log("stega controller stopped (editor mode)");
+      debug6.log("stega controller stopped (editor mode)");
       return;
     }
     if (throttledMouseMove) {
@@ -1020,43 +1008,11 @@ function createStegaController(opts) {
     elements.cleanup();
     removeStegaStyles();
     initialized = false;
-    debug7.log("stega controller stopped");
+    debug6.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",
@@ -2169,7 +2125,7 @@ function definePreprToolbar() {
 }
 
 // src/core/create-preview.ts
-var debug9 = createScopedLogger("create-preview");
+var debug7 = createScopedLogger("create-preview");
 var controllerStores = /* @__PURE__ */ new WeakMap();
 function defaultNavigation() {
   return {
@@ -2211,7 +2167,7 @@ function createPreprPreview(opts = {}) {
   const search = new URLSearchParams(window.location.search);
   const hideBar = search.get(PARAM_HIDE_BAR) === "true";
   if (hideBar) {
-    debug9.log(`${PARAM_HIDE_BAR}=true \u2014 no visible toolbar`);
+    debug7.log(`${PARAM_HIDE_BAR}=true \u2014 no visible toolbar`);
   }
   const mountUi = (options?.ui ?? true) && !isIframe && !hideBar;
   const locale = resolveLocale(options);
@@ -2247,17 +2203,18 @@ 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, id, field, locale: contentLocale }) => {
+    onEdit: ({ href, origin, id, field }) => {
       const safeHref = href ? safeEditUrl(href) : null;
       if (href && !safeHref) {
-        debug9.warn("ignored edit request with unsupported href scheme");
+        debug7.warn("ignored edit request with unsupported href scheme");
         return;
       }
       if (isIframe) {
         sendPreprEvent("field_edit_requested", {
+          href: safeHref ?? void 0,
+          origin,
           id,
-          field,
-          locale: contentLocale
+          field
         });
       } else if (safeHref) {
         window.open(safeHref, "_blank", "noopener,noreferrer");
@@ -2265,7 +2222,8 @@ function createPreprPreview(opts = {}) {
     }
   });
   const autoClean = createStegaAutoClean({
-    enabled: options?.autoClean
+    enabled: options?.autoClean,
+    isHydrated: opts.isHydrated
   });
   autoClean.start();
   const handleChange = createChangeHandler({
@@ -2284,15 +2242,7 @@ function createPreprPreview(opts = {}) {
     handleChange(before, state);
   });
   const bridge = createIframeBridge(store, {
-    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);
-      }
-    }
+    allowedEditorOrigins: options?.allowedEditorOrigins
   });
   sendPreprEvent(
     "getScrollPosition",
@@ -2312,15 +2262,34 @@ function createPreprPreview(opts = {}) {
       bridge.stop();
     }
     el?.remove();
-    debug9.log("preview destroyed");
+    debug7.log("preview destroyed");
   }
   const controller = { destroy };
   controllerStores.set(controller, store);
   return controller;
 }
 
+// src/react/hydration.ts
+var PROPS_KEY_PREFIX = "__reactProps$";
+function reactProps(element) {
+  for (const key of Object.keys(element)) {
+    if (key.startsWith(PROPS_KEY_PREFIX)) {
+      return element[key];
+    }
+  }
+  return void 0;
+}
+function isReactHydrated(text) {
+  for (let el = text.parentElement; el; el = el.parentElement) {
+    const props = reactProps(el);
+    if (!props) continue;
+    return el === text.parentElement || props.dangerouslySetInnerHTML != null;
+  }
+  return true;
+}
+
 // src/version.ts
-var VERSION = "0.5.0-rc.1";
+var VERSION = "0.6.0-alpha.0";
 
 // src/core/pixel.ts
 var PIXEL_SCRIPT_URL = "https://cdn.tracking.prepr.io/js/prepr.min.js";
@@ -2368,7 +2337,12 @@ function PreprPreview({
   ...props
 }) {
   useEffect(() => {
-    const preview = createPreprPreview({ props, options, navigation });
+    const preview = createPreprPreview({
+      props,
+      options,
+      navigation,
+      isHydrated: isReactHydrated
+    });
     return () => preview.destroy();
   }, []);
   return null;

package/dist/server-Brr1UgtW.d.ts

@@ -0,0 +1,59 @@
+import { a as PreprErrorCode, c as PreprSegment, P as PreprHeaders, b as PreprFeatures, e as PreprToolbarProps } from './types-BYH9XqmN.js';
+
+/**
+ * Whether a Prepr GraphQL response differs per visitor, read from its `Vary`
+ * header. Use it when fetching with your own GraphQL client; the toolkit's
+ * `createPreprClient` already returns it as `personalized`.
+ *
+ * Never throws; a response without `Vary` is not personalized.
+ */
+declare function isPersonalizedResponse(source: Response | Headers): boolean;
+
+/** Error thrown by the token helpers and the segments fetch. */
+declare class PreprError extends Error {
+    readonly code: PreprErrorCode;
+    readonly context?: string | undefined;
+    readonly originalError?: Error | undefined;
+    constructor(message: string, code: PreprErrorCode, context?: string | undefined, originalError?: Error | undefined);
+}
+/** Prepr Customer ID, or null if the middleware did not run for this request. */
+declare function getPreprUUIDFromHeaders(headers: Headers): string | null;
+/** Active segment ID, or null when no segment is selected. */
+declare function getActiveSegmentFromHeaders(headers: Headers): string | null;
+/** Active A/B variant (`'A'`/`'B'`), or null when no test is running. */
+declare function getActiveVariantFromHeaders(headers: Headers): string | null;
+/**
+ * Collect the Prepr headers into a `PreprHeaders`. Lookups are case-insensitive
+ * per the Fetch spec, but the returned keys use the declared casing.
+ */
+declare function getPreprHeadersFromHeaders(headers: Headers): PreprHeaders;
+/**
+ * Asserts `token` is the full `https://graphql.prepr.io/<token>` URL.
+ * @throws PreprError if the token is missing or not an HTTPS URL.
+ */
+declare function validatePreprToken(token: string): void;
+/**
+ * Pulls the access token out of a GraphQL URL: `https://graphql.prepr.io/abc123`
+ * -> `abc123`.
+ * @throws PreprError if the URL is not a valid `graphql.prepr.io` URL.
+ */
+declare function extractAccessToken(graphqlUrl: string): string;
+/**
+ * Fetches the environment's segments from the Prepr API.
+ *
+ * `token` must be a Prepr GraphQL URL with scope 'segments'.
+ * @throws PreprError if the token is invalid or the request fails.
+ */
+declare function getPreprEnvironmentSegments(token: string): Promise<PreprSegment[]>;
+/**
+ * Never throws: a failed segments fetch yields an empty list so the toolbar
+ * still renders. The list is returned under both `segments` and the deprecated
+ * `data` alias.
+ *
+ * Pass the same `features` object you give the toolbar and the middleware: with
+ * segments disabled the `_Segments` request is skipped entirely, saving a
+ * round-trip per page.
+ */
+declare function getToolbarPropsFromHeaders(headers: Headers, token: string, features?: PreprFeatures): Promise<PreprToolbarProps>;
+
+export { PreprError as P, getActiveVariantFromHeaders as a, getPreprEnvironmentSegments as b, getPreprHeadersFromHeaders as c, getPreprUUIDFromHeaders as d, extractAccessToken as e, getToolbarPropsFromHeaders as f, getActiveSegmentFromHeaders as g, isPersonalizedResponse as i, validatePreprToken as v };

package/dist/server-DJuS3YU0.d.cts

@@ -0,0 +1,59 @@
+import { a as PreprErrorCode, c as PreprSegment, P as PreprHeaders, b as PreprFeatures, e as PreprToolbarProps } from './types-BYH9XqmN.cjs';
+
+/**
+ * Whether a Prepr GraphQL response differs per visitor, read from its `Vary`
+ * header. Use it when fetching with your own GraphQL client; the toolkit's
+ * `createPreprClient` already returns it as `personalized`.
+ *
+ * Never throws; a response without `Vary` is not personalized.
+ */
+declare function isPersonalizedResponse(source: Response | Headers): boolean;
+
+/** Error thrown by the token helpers and the segments fetch. */
+declare class PreprError extends Error {
+    readonly code: PreprErrorCode;
+    readonly context?: string | undefined;
+    readonly originalError?: Error | undefined;
+    constructor(message: string, code: PreprErrorCode, context?: string | undefined, originalError?: Error | undefined);
+}
+/** Prepr Customer ID, or null if the middleware did not run for this request. */
+declare function getPreprUUIDFromHeaders(headers: Headers): string | null;
+/** Active segment ID, or null when no segment is selected. */
+declare function getActiveSegmentFromHeaders(headers: Headers): string | null;
+/** Active A/B variant (`'A'`/`'B'`), or null when no test is running. */
+declare function getActiveVariantFromHeaders(headers: Headers): string | null;
+/**
+ * Collect the Prepr headers into a `PreprHeaders`. Lookups are case-insensitive
+ * per the Fetch spec, but the returned keys use the declared casing.
+ */
+declare function getPreprHeadersFromHeaders(headers: Headers): PreprHeaders;
+/**
+ * Asserts `token` is the full `https://graphql.prepr.io/<token>` URL.
+ * @throws PreprError if the token is missing or not an HTTPS URL.
+ */
+declare function validatePreprToken(token: string): void;
+/**
+ * Pulls the access token out of a GraphQL URL: `https://graphql.prepr.io/abc123`
+ * -> `abc123`.
+ * @throws PreprError if the URL is not a valid `graphql.prepr.io` URL.
+ */
+declare function extractAccessToken(graphqlUrl: string): string;
+/**
+ * Fetches the environment's segments from the Prepr API.
+ *
+ * `token` must be a Prepr GraphQL URL with scope 'segments'.
+ * @throws PreprError if the token is invalid or the request fails.
+ */
+declare function getPreprEnvironmentSegments(token: string): Promise<PreprSegment[]>;
+/**
+ * Never throws: a failed segments fetch yields an empty list so the toolbar
+ * still renders. The list is returned under both `segments` and the deprecated
+ * `data` alias.
+ *
+ * Pass the same `features` object you give the toolbar and the middleware: with
+ * segments disabled the `_Segments` request is skipped entirely, saving a
+ * round-trip per page.
+ */
+declare function getToolbarPropsFromHeaders(headers: Headers, token: string, features?: PreprFeatures): Promise<PreprToolbarProps>;
+
+export { PreprError as P, getActiveVariantFromHeaders as a, getPreprEnvironmentSegments as b, getPreprHeadersFromHeaders as c, getPreprUUIDFromHeaders as d, extractAccessToken as e, getToolbarPropsFromHeaders as f, getActiveSegmentFromHeaders as g, isPersonalizedResponse as i, validatePreprToken as v };