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

package/dist/index.d.ts

@@ -1,11 +1,13 @@
-import { P as PreprFeatures, R as ResolvedPreprFeatures, L as Locale, a as PreprSegment, b as PreprVariant, c as PreprToolbarProps, d as PreprPreviewOptions, e as PreprErrorCode, f as PreprHeaders } from './pixel-B3oQNbZ3.js';
-export { g as PreprEnvironment, h as PreprEventType, i as PreprFeatureConfig, j as PreprHeaderName, k as PreprPixelConfig, l as PreprToolbarComponentProps, m as PreprToolbarOptions, n as loadTrackingPixel, s as setTrackingParam, t as trackEvent } from './pixel-B3oQNbZ3.js';
+import { b as PreprFeatures, R as ResolvedPreprFeatures, L as Locale, c as PreprSegment, d as PreprVariant, e as PreprToolbarProps, f as PreprPreviewOptions } from './types-BYH9XqmN.js';
+export { g as PreprEnvironment, a as PreprErrorCode, h as PreprEventType, i as PreprFeatureConfig, j as PreprHeaderName, P as PreprHeaders, k as PreprToolbarComponentProps, l as PreprToolbarOptions } from './types-BYH9XqmN.js';
+export { P as PreprError, e as extractAccessToken, g as getActiveSegmentFromHeaders, a as getActiveVariantFromHeaders, b as getPreprEnvironmentSegments, c as getPreprHeadersFromHeaders, d as getPreprUUIDFromHeaders, f as getToolbarPropsFromHeaders, i as isPersonalizedResponse, v as validatePreprToken } from './server-Brr1UgtW.js';
+export { P as PreprPixelConfig, l as loadTrackingPixel, s as setTrackingParam, t as trackEvent } from './pixel-DwW7cXJm.js';
 
 /**
  * Package version; must match package.json. Lives in its own leaf module so
  * core can import it without cycling through the barrel.
  */
-declare const VERSION = "0.5.0-rc.2";
+declare const VERSION = "0.6.0-alpha.0";
 
 /**
  * Resolve a `PreprFeatures` bag to plain booleans, defaulting every omitted key
@@ -65,6 +67,11 @@ interface CreatePreprPreviewOptions {
     props?: PreprToolbarProps;
     options?: PreprPreviewOptions;
     navigation?: PreprNavigationAdapter;
+    /**
+     * @internal Supplied by framework wrappers so stega stripping waits until
+     * the framework has hydrated the text it would change.
+     */
+    isHydrated?: (node: Text) => boolean;
 }
 interface PreprPreviewController {
     destroy(): void;
@@ -137,73 +144,14 @@ declare class PreprToolbarElement extends HTMLElementBase {
 /** Idempotent, including across bundles that each try to define the element. */
 declare function definePreprToolbar(): void;
 
-/** Which field the editor asked the preview to bring on screen. */
-interface ScrollToFieldMessage {
-    field: string;
-    id?: string;
-}
 interface IframeBridgeOptions {
     /**
      * Replace the `*.prepr.io` wildcard with an exact origin list. Intended for
-     * self-hosted editors; when set, the wildcard no longer applies. `['*']`
-     * accepts any editor origin — see `PreprPreviewOptions.allowedEditorOrigins`.
+     * self-hosted editors; when set, the wildcard no longer applies.
      */
     allowedEditorOrigins?: string[];
-    /**
-     * Called when the editor selects a field and wants the preview to scroll to
-     * it. Only fires for messages from the handshaked editor origin. The bridge
-     * stays free of DOM lookups: the preview runtime supplies `scrollToField`.
-     */
-    onScrollToField?: (message: ScrollToFieldMessage) => void;
 }
 
-/** 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>;
-
 interface CookieSpec {
     name: string;
     value: string;
@@ -242,4 +190,4 @@ interface PreprMiddlewareOptions {
  */
 declare function processPreprRequest(request: Request, opts?: PreprMiddlewareOptions): PreprMiddlewareResult;
 
-export { type CookieSpec, type CreatePreprPreviewOptions, type IframeBridgeOptions, PreprError, PreprErrorCode, PreprFeatures, PreprHeaders, type PreprMiddlewareOptions, type PreprMiddlewareResult, type PreprNavigationAdapter, type PreprPreviewController, PreprPreviewOptions, PreprSegment, PreprToolbarElement, PreprToolbarProps, PreprVariant, ResolvedPreprFeatures, type ToolbarState, type ToolbarStore, VERSION, createPreprPreview, createToolbarStore, definePreprToolbar, extractAccessToken, getActiveSegmentFromHeaders, getActiveVariantFromHeaders, getPreprEnvironmentSegments, getPreprHeadersFromHeaders, getPreprUUIDFromHeaders, getToolbarPropsFromHeaders, processPreprRequest, resolveFeatures, stegaClean, validatePreprToken };
+export { type CookieSpec, type CreatePreprPreviewOptions, type IframeBridgeOptions, PreprFeatures, type PreprMiddlewareOptions, type PreprMiddlewareResult, type PreprNavigationAdapter, type PreprPreviewController, PreprPreviewOptions, PreprSegment, PreprToolbarElement, PreprToolbarProps, PreprVariant, ResolvedPreprFeatures, type ToolbarState, type ToolbarStore, VERSION, createPreprPreview, createToolbarStore, definePreprToolbar, processPreprRequest, resolveFeatures, stegaClean };

package/dist/index.js

@@ -9,179 +9,30 @@ import {
   PARAM_SEGMENT,
   PARAM_VARIANT,
   PreprToolbarElement,
-  VERSION,
   createPreprPreview,
   createToolbarStore,
   definePreprToolbar,
   loadTrackingPixel,
-  resolveFeatures,
   setTrackingParam,
-  stegaClean,
   trackEvent
-} from "./chunk-FLPNN3CV.js";
-
-// src/core/server.ts
-var PreprError = class extends Error {
-  constructor(message, code, context, originalError) {
-    super(message);
-    this.code = code;
-    this.context = context;
-    this.originalError = originalError;
-    this.name = "PreprError";
-  }
-};
-function getPreprUUIDFromHeaders(headers) {
-  return headers.get("prepr-customer-id");
-}
-function getActiveSegmentFromHeaders(headers) {
-  return headers.get("Prepr-Segments");
-}
-function getActiveVariantFromHeaders(headers) {
-  return headers.get("Prepr-ABtesting");
-}
-var PREPR_HEADER_KEYS = [
-  "prepr-customer-id",
-  "Prepr-Segments",
-  "Prepr-ABtesting",
-  "Prepr-Preview-Bar",
-  "Prepr-Context-utm_source",
-  "Prepr-Context-utm_medium",
-  "Prepr-Context-utm_term",
-  "Prepr-Context-utm_content",
-  "Prepr-Context-utm_campaign",
-  "Prepr-Context-initial_referral",
-  "Prepr-Visitor-IP",
-  "Prepr-Hubspot-Id",
-  "Prepr-Customer-Id-Created",
-  "User-Agent",
-  "Prepr-Package"
-];
-function getPreprHeadersFromHeaders(headers) {
-  const preprHeaders = {};
-  const copy = (key) => {
-    const value = headers.get(key);
-    if (value !== null) {
-      preprHeaders[key] = value;
-    }
-  };
-  for (const key of PREPR_HEADER_KEYS) {
-    copy(key);
-  }
-  return preprHeaders;
-}
-function validatePreprToken(token) {
-  if (!token) {
-    throw new PreprError(
-      "Token is required",
-      "MISSING_TOKEN",
-      "validatePreprToken"
-    );
-  }
-  if (!token.startsWith("https://")) {
-    throw new PreprError(
-      "Token must be a valid HTTPS URL",
-      "INVALID_TOKEN",
-      "validatePreprToken"
-    );
-  }
-}
-function extractAccessToken(graphqlUrl) {
-  let url;
-  try {
-    url = new URL(graphqlUrl);
-  } catch (error) {
-    throw new PreprError(
-      "Token must be a valid URL",
-      "INVALID_TOKEN",
-      "extractAccessToken",
-      error instanceof Error ? error : new Error(String(error))
-    );
-  }
-  if (url.hostname !== "graphql.prepr.io") {
-    throw new PreprError(
-      "Token must be a graphql.prepr.io URL",
-      "INVALID_TOKEN",
-      "extractAccessToken"
-    );
-  }
-  const pathParts = url.pathname.split("/");
-  const token = pathParts[pathParts.length - 1];
-  if (!token) {
-    throw new PreprError(
-      "Token URL is missing an access token segment",
-      "INVALID_TOKEN",
-      "extractAccessToken"
-    );
-  }
-  return token;
-}
-async function getPreprEnvironmentSegments(token) {
-  validatePreprToken(token);
-  try {
-    const response = await fetch(token, {
-      headers: {
-        "Prepr-Package": `@preprio/toolkit@${VERSION}`,
-        // Duplicates the version in Prepr-Package. It keeps the User-Agent
-        // format used by `@preprio/prepr-nextjs`, for Prepr API consumers that
-        // still identify the toolbar by that string.
-        "User-Agent": `Prepr-Preview-Bar/${VERSION}`,
-        "Content-Type": "application/json"
-      },
-      method: "POST",
-      body: JSON.stringify({
-        query: `{
-                _Segments {
-                    _id
-                    name
-                }
-            }`
-      })
-    });
-    if (!response.ok) {
-      throw new PreprError(
-        `HTTP ${response.status}: ${response.statusText}`,
-        "HTTP_ERROR",
-        "getPreprEnvironmentSegments"
-      );
-    }
-    const json = await response.json();
-    if (!json || !json.data || !json.data._Segments) {
-      throw new PreprError(
-        "Invalid response format from Prepr API",
-        "INVALID_RESPONSE",
-        "getPreprEnvironmentSegments"
-      );
-    }
-    return json.data._Segments;
-  } catch (error) {
-    if (error instanceof PreprError) {
-      throw error;
-    }
-    throw new PreprError(
-      "Failed to fetch segments from Prepr API",
-      "FETCH_ERROR",
-      "getPreprEnvironmentSegments",
-      error instanceof Error ? error : new Error(String(error))
-    );
-  }
-}
-async function getToolbarPropsFromHeaders(headers, token, features) {
-  const resolved = resolveFeatures(features);
-  let segments = [];
-  if (resolved.segments) {
-    try {
-      segments = await getPreprEnvironmentSegments(token);
-    } catch {
-      segments = [];
-    }
-  }
-  return {
-    activeSegment: resolved.segments ? getActiveSegmentFromHeaders(headers) : null,
-    activeVariant: resolved.abTesting ? getActiveVariantFromHeaders(headers) : null,
-    segments,
-    data: segments
-  };
-}
+} from "./chunk-BJ2LBLWO.js";
+import {
+  PreprError,
+  extractAccessToken,
+  getActiveSegmentFromHeaders,
+  getActiveVariantFromHeaders,
+  getPreprEnvironmentSegments,
+  getPreprHeadersFromHeaders,
+  getPreprUUIDFromHeaders,
+  getToolbarPropsFromHeaders,
+  isPersonalizedResponse,
+  validatePreprToken
+} from "./chunk-YR7P4IWE.js";
+import {
+  VERSION,
+  resolveFeatures,
+  stegaClean
+} from "./chunk-DGZA7KX7.js";
 
 // src/core/middleware.ts
 var UTM_PARAMS = [
@@ -335,6 +186,10 @@ function processFrameworkRequest(request, opts, framework) {
       });
     }
   }
+  if (requestHeaders.has("Prepr-Segments")) {
+    requestHeaders.delete("Prepr-Customer-Id");
+    requestHeaders.delete("Prepr-Customer-Id-Created");
+  }
   return { requestHeaders, responseCookies };
 }
 export {
@@ -351,6 +206,7 @@ export {
   getPreprHeadersFromHeaders,
   getPreprUUIDFromHeaders,
   getToolbarPropsFromHeaders,
+  isPersonalizedResponse,
   loadTrackingPixel,
   processPreprRequest,
   resolveFeatures,

package/dist/nextjs/chunk-U4HXENF7.js

@@ -0,0 +1,231 @@
+// src/version.ts
+var VERSION = "0.6.0-alpha.0";
+
+// src/core/features.ts
+function isEnabled(config) {
+  if (typeof config === "boolean") return config;
+  return config?.enabled ?? true;
+}
+function resolveFeatures(features) {
+  return {
+    segments: isEnabled(features?.segments),
+    abTesting: isEnabled(features?.abTesting),
+    editMode: isEnabled(features?.editMode)
+  };
+}
+var ALL_FEATURES_ENABLED = Object.freeze({
+  segments: true,
+  abTesting: true,
+  editMode: true
+});
+
+// src/core/server.ts
+var PreprError = class extends Error {
+  constructor(message, code, context, originalError) {
+    super(message);
+    this.code = code;
+    this.context = context;
+    this.originalError = originalError;
+    this.name = "PreprError";
+  }
+};
+function getPreprUUIDFromHeaders(headers2) {
+  return headers2.get("prepr-customer-id");
+}
+function getActiveSegmentFromHeaders(headers2) {
+  return headers2.get("Prepr-Segments");
+}
+function getActiveVariantFromHeaders(headers2) {
+  return headers2.get("Prepr-ABtesting");
+}
+var PREPR_HEADER_KEYS = [
+  "prepr-customer-id",
+  "Prepr-Segments",
+  "Prepr-ABtesting",
+  "Prepr-Preview-Bar",
+  "Prepr-Context-utm_source",
+  "Prepr-Context-utm_medium",
+  "Prepr-Context-utm_term",
+  "Prepr-Context-utm_content",
+  "Prepr-Context-utm_campaign",
+  "Prepr-Context-initial_referral",
+  "Prepr-Visitor-IP",
+  "Prepr-Hubspot-Id",
+  "Prepr-Customer-Id-Created",
+  "User-Agent",
+  "Prepr-Package"
+];
+function getPreprHeadersFromHeaders(headers2) {
+  const preprHeaders = {};
+  const copy = (key) => {
+    const value = headers2.get(key);
+    if (value !== null) {
+      preprHeaders[key] = value;
+    }
+  };
+  for (const key of PREPR_HEADER_KEYS) {
+    copy(key);
+  }
+  return preprHeaders;
+}
+function validatePreprToken(token) {
+  if (!token) {
+    throw new PreprError(
+      "Token is required",
+      "MISSING_TOKEN",
+      "validatePreprToken"
+    );
+  }
+  if (!token.startsWith("https://")) {
+    throw new PreprError(
+      "Token must be a valid HTTPS URL",
+      "INVALID_TOKEN",
+      "validatePreprToken"
+    );
+  }
+}
+function extractAccessToken(graphqlUrl) {
+  let url;
+  try {
+    url = new URL(graphqlUrl);
+  } catch (error) {
+    throw new PreprError(
+      "Token must be a valid URL",
+      "INVALID_TOKEN",
+      "extractAccessToken",
+      error instanceof Error ? error : new Error(String(error))
+    );
+  }
+  if (url.hostname !== "graphql.prepr.io") {
+    throw new PreprError(
+      "Token must be a graphql.prepr.io URL",
+      "INVALID_TOKEN",
+      "extractAccessToken"
+    );
+  }
+  const pathParts = url.pathname.split("/");
+  const token = pathParts[pathParts.length - 1];
+  if (!token) {
+    throw new PreprError(
+      "Token URL is missing an access token segment",
+      "INVALID_TOKEN",
+      "extractAccessToken"
+    );
+  }
+  return token;
+}
+async function getPreprEnvironmentSegments(token) {
+  validatePreprToken(token);
+  try {
+    const response = await fetch(token, {
+      headers: {
+        "Prepr-Package": `@preprio/toolkit@${VERSION}`,
+        // Duplicates the version in Prepr-Package. It keeps the User-Agent
+        // format used by `@preprio/prepr-nextjs`, for Prepr API consumers that
+        // still identify the toolbar by that string.
+        "User-Agent": `Prepr-Preview-Bar/${VERSION}`,
+        "Content-Type": "application/json"
+      },
+      method: "POST",
+      body: JSON.stringify({
+        query: `{
+                _Segments {
+                    _id
+                    name
+                }
+            }`
+      })
+    });
+    if (!response.ok) {
+      throw new PreprError(
+        `HTTP ${response.status}: ${response.statusText}`,
+        "HTTP_ERROR",
+        "getPreprEnvironmentSegments"
+      );
+    }
+    const json = await response.json();
+    if (!json || !json.data || !json.data._Segments) {
+      throw new PreprError(
+        "Invalid response format from Prepr API",
+        "INVALID_RESPONSE",
+        "getPreprEnvironmentSegments"
+      );
+    }
+    return json.data._Segments;
+  } catch (error) {
+    if (error instanceof PreprError) {
+      throw error;
+    }
+    throw new PreprError(
+      "Failed to fetch segments from Prepr API",
+      "FETCH_ERROR",
+      "getPreprEnvironmentSegments",
+      error instanceof Error ? error : new Error(String(error))
+    );
+  }
+}
+async function getToolbarPropsFromHeaders(headers2, token, features) {
+  const resolved = resolveFeatures(features);
+  let segments = [];
+  if (resolved.segments) {
+    try {
+      segments = await getPreprEnvironmentSegments(token);
+    } catch {
+      segments = [];
+    }
+  }
+  return {
+    activeSegment: resolved.segments ? getActiveSegmentFromHeaders(headers2) : null,
+    activeVariant: resolved.abTesting ? getActiveVariantFromHeaders(headers2) : null,
+    segments,
+    data: segments
+  };
+}
+
+// src/nextjs/server.ts
+import { headers } from "next/headers";
+async function readHeaders() {
+  return await headers();
+}
+async function getPreprUUID() {
+  const h = await readHeaders();
+  return getPreprUUIDFromHeaders(h);
+}
+async function getActiveSegment() {
+  const h = await readHeaders();
+  return getActiveSegmentFromHeaders(h);
+}
+async function getActiveVariant() {
+  const h = await readHeaders();
+  return getActiveVariantFromHeaders(h);
+}
+async function getPreprHeaders() {
+  const h = await readHeaders();
+  return getPreprHeadersFromHeaders(h);
+}
+async function getToolbarProps(token, features) {
+  const h = await readHeaders();
+  return getToolbarPropsFromHeaders(h, token, features);
+}
+
+// src/core/personalization.ts
+var PERSONALIZED_VARY = /\bPrepr-(Segments|ABTesting)/i;
+function isPersonalizedResponse(source) {
+  const headers2 = "headers" in source ? source.headers : source;
+  return PERSONALIZED_VARY.test(headers2.get("vary") ?? "");
+}
+
+export {
+  VERSION,
+  resolveFeatures,
+  PreprError,
+  getPreprHeadersFromHeaders,
+  validatePreprToken,
+  extractAccessToken,
+  getPreprUUID,
+  getActiveSegment,
+  getActiveVariant,
+  getPreprHeaders,
+  getToolbarProps,
+  isPersonalizedResponse
+};