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

package/dist/nuxt/index.cjs

@@ -30,12 +30,13 @@ __export(nuxt_exports, {
   getPreprUUID: () => getPreprUUID,
   getToolbarProps: () => getToolbarProps,
   handlePreprRequest: () => handlePreprRequest,
+  isPersonalizedResponse: () => isPersonalizedResponse,
   validatePreprToken: () => validatePreprToken
 });
 module.exports = __toCommonJS(nuxt_exports);
 
 // src/version.ts
-var VERSION = "0.5.0-rc.2";
+var VERSION = "0.6.0-alpha.0";
 
 // src/core/constants.ts
 var COOKIE_PREVIEW_MODE = "Prepr-Preview-Mode";
@@ -229,6 +230,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 };
 }
 
@@ -442,6 +447,13 @@ function getPreprHeaders(headers) {
 async function getToolbarProps(headers, token, features) {
   return getToolbarPropsFromHeaders(headers, token, features);
 }
+
+// src/core/personalization.ts
+var PERSONALIZED_VARY = /\bPrepr-(Segments|ABTesting)/i;
+function isPersonalizedResponse(source) {
+  const headers = "headers" in source ? source.headers : source;
+  return PERSONALIZED_VARY.test(headers.get("vary") ?? "");
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   PREPR_CONTEXT_KEY,
@@ -454,5 +466,6 @@ async function getToolbarProps(headers, token, features) {
   getPreprUUID,
   getToolbarProps,
   handlePreprRequest,
+  isPersonalizedResponse,
   validatePreprToken
 });

package/dist/nuxt/index.d.cts

@@ -1,131 +1,5 @@
-interface PreprSegment {
-    readonly _id: string;
-    readonly name: string;
-}
-/**
- * Per-feature config. `false` is shorthand for `{ enabled: false }`; the object
- * form leaves room for per-feature options later without a breaking change.
- */
-type PreprFeatureConfig = boolean | {
-    enabled?: boolean;
-};
-/** Toolkit features a consumer can turn off. Omitted keys stay enabled. */
-interface PreprFeatures {
-    /** Segment picker, `Prepr-Segments` header and its cookie/query param. */
-    segments?: PreprFeatureConfig;
-    /** A/B variant switch, `Prepr-ABtesting` header and its cookie/query param. */
-    abTesting?: PreprFeatureConfig;
-    /**
-     * The site's own click-to-edit: the toolbar's Edit mode control, the stega
-     * tooltip/overlay and the close-edit pill.
-     *
-     * NOT a security control, and NOT the Prepr editor's live preview. When the
-     * site is framed by the editor, `prepr:initVE` still activates edit mode —
-     * that is the CMS operating inside its own iframe, not an affordance offered
-     * to visitors. See iframe-bridge.ts.
-     */
-    editMode?: PreprFeatureConfig;
-}
-interface PreprToolbarProps {
-    /**
-     * Server-resolved active segment. Optional: omit it with `segments`
-     * disabled, where there is nothing to resolve. When enabled and omitted,
-     * the persisted cookie is used.
-     */
-    readonly activeSegment?: string | null;
-    /**
-     * Server-resolved active A/B variant. Optional: omit it with `abTesting`
-     * disabled, where there is nothing to resolve. When enabled and omitted,
-     * the persisted cookie is used.
-     */
-    readonly activeVariant?: string | null;
-    /** Available segments to personalize on. */
-    readonly segments?: readonly PreprSegment[];
-    /** @deprecated Alias for `segments`. */
-    readonly data?: readonly PreprSegment[];
-}
-type PreprVariant = 'A' | 'B';
-interface PreprHeaders {
-    readonly 'prepr-customer-id'?: string;
-    readonly 'Prepr-Segments'?: string;
-    readonly 'Prepr-ABtesting'?: PreprVariant;
-    readonly 'Prepr-Preview-Bar'?: 'true';
-    readonly 'Prepr-Context-utm_source'?: string;
-    readonly 'Prepr-Context-utm_medium'?: string;
-    readonly 'Prepr-Context-utm_term'?: string;
-    readonly 'Prepr-Context-utm_content'?: string;
-    readonly 'Prepr-Context-utm_campaign'?: string;
-    readonly 'Prepr-Context-initial_referral'?: string;
-    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;
-}
-type PreprErrorCode = 'INVALID_TOKEN' | 'MISSING_TOKEN' | 'HTTP_ERROR' | 'FETCH_ERROR' | 'INVALID_RESPONSE' | 'CONTEXT_ERROR';
-
-interface PreprMiddlewareOptions {
-    /** Enable preview-mode headers (segment/AB overrides, preview bar). */
-    preview?: boolean;
-    /**
-     * Disable features app-wide. Pass the same object you give the toolbar: a
-     * disabled feature injects no header and persists no cookie, whatever the
-     * request carries.
-     */
-    features?: PreprFeatures;
-    /** Override the version reported in Prepr-Package (mainly for tests). */
-    version?: string;
-}
-
-/**
- * Structural stand-in for h3's `H3Event`, so this package needs no build-time
- * dependency on `h3`/`nuxt`. Only the fields `handlePreprRequest` uses.
- *
- * `node` ties this to Nitro's Node.js preset (the Nuxt default). Edge presets
- * expose no raw Node request/response to fold headers back onto.
- */
-interface H3EventLike {
-    node: {
-        req: {
-            url?: string;
-            headers: Record<string, string | string[] | undefined>;
-        };
-        res: {
-            /** Node's `ServerResponse.appendHeader` (Node >= 18.3). */
-            appendHeader(name: string, value: string): unknown;
-        };
-    };
-    /** Request-scoped bag shared with route handlers and Vue via `useRequestEvent`. */
-    context: Record<string, unknown>;
-}
-/** Key under which `handlePreprRequest` mirrors the forwarded Prepr `Headers`. */
-declare const PREPR_CONTEXT_KEY = "prepr";
-/**
- * Nuxt server middleware entry point — call it inside `defineEventHandler` in
- * `server/middleware/prepr.ts`:
- *
- * ```ts
- * export default defineEventHandler(event => {
- *   handlePreprRequest(event, { preview: import.meta.dev });
- * });
- * ```
- *
- * The computed Prepr headers are folded back onto the raw Node request
- * (lowercased, as Node stores them), which is what `useRequestHeaders()` and
- * downstream handlers read. The same `Headers` are mirrored onto
- * `event.context.prepr` for callers who prefer an explicit read
- * (`getPreprHeadersFromEvent`). Cookies are appended to the response.
- */
-declare function handlePreprRequest(event: H3EventLike, options?: PreprMiddlewareOptions): void;
-/**
- * Personalization headers to forward to your GraphQL fetch, from the h3 event.
- * Empty `Headers` if `handlePreprRequest` did not run, so the result is always
- * safe to spread.
- */
-declare function getPreprHeadersFromEvent(event: Pick<H3EventLike, 'context'>): Headers;
+import { P as PreprHeaders, b as PreprFeatures, c as PreprToolbarProps } from './server-8v6OHbsw.cjs';
+export { H as H3EventLike, d as PREPR_CONTEXT_KEY, a as PreprError, e as PreprMiddlewareOptions, f as extractAccessToken, g as getPreprHeadersFromEvent, h as handlePreprRequest, i as isPersonalizedResponse, v as validatePreprToken } from './server-8v6OHbsw.cjs';
 
 /** Returns the Prepr Customer ID from the request headers. */
 declare function getPreprUUID(headers: Headers): string | null;
@@ -142,23 +16,4 @@ declare function getPreprHeaders(headers: Headers): PreprHeaders;
  */
 declare function getToolbarProps(headers: Headers, token: string, features?: PreprFeatures): Promise<PreprToolbarProps>;
 
-/** 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);
-}
-/**
- * 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;
-
-export { type H3EventLike, PREPR_CONTEXT_KEY, PreprError, type PreprMiddlewareOptions, extractAccessToken, getActiveSegment, getActiveVariant, getPreprHeaders, getPreprHeadersFromEvent, getPreprUUID, getToolbarProps, handlePreprRequest, validatePreprToken };
+export { getActiveSegment, getActiveVariant, getPreprHeaders, getPreprUUID, getToolbarProps };

package/dist/nuxt/index.d.ts

@@ -1,131 +1,5 @@
-interface PreprSegment {
-    readonly _id: string;
-    readonly name: string;
-}
-/**
- * Per-feature config. `false` is shorthand for `{ enabled: false }`; the object
- * form leaves room for per-feature options later without a breaking change.
- */
-type PreprFeatureConfig = boolean | {
-    enabled?: boolean;
-};
-/** Toolkit features a consumer can turn off. Omitted keys stay enabled. */
-interface PreprFeatures {
-    /** Segment picker, `Prepr-Segments` header and its cookie/query param. */
-    segments?: PreprFeatureConfig;
-    /** A/B variant switch, `Prepr-ABtesting` header and its cookie/query param. */
-    abTesting?: PreprFeatureConfig;
-    /**
-     * The site's own click-to-edit: the toolbar's Edit mode control, the stega
-     * tooltip/overlay and the close-edit pill.
-     *
-     * NOT a security control, and NOT the Prepr editor's live preview. When the
-     * site is framed by the editor, `prepr:initVE` still activates edit mode —
-     * that is the CMS operating inside its own iframe, not an affordance offered
-     * to visitors. See iframe-bridge.ts.
-     */
-    editMode?: PreprFeatureConfig;
-}
-interface PreprToolbarProps {
-    /**
-     * Server-resolved active segment. Optional: omit it with `segments`
-     * disabled, where there is nothing to resolve. When enabled and omitted,
-     * the persisted cookie is used.
-     */
-    readonly activeSegment?: string | null;
-    /**
-     * Server-resolved active A/B variant. Optional: omit it with `abTesting`
-     * disabled, where there is nothing to resolve. When enabled and omitted,
-     * the persisted cookie is used.
-     */
-    readonly activeVariant?: string | null;
-    /** Available segments to personalize on. */
-    readonly segments?: readonly PreprSegment[];
-    /** @deprecated Alias for `segments`. */
-    readonly data?: readonly PreprSegment[];
-}
-type PreprVariant = 'A' | 'B';
-interface PreprHeaders {
-    readonly 'prepr-customer-id'?: string;
-    readonly 'Prepr-Segments'?: string;
-    readonly 'Prepr-ABtesting'?: PreprVariant;
-    readonly 'Prepr-Preview-Bar'?: 'true';
-    readonly 'Prepr-Context-utm_source'?: string;
-    readonly 'Prepr-Context-utm_medium'?: string;
-    readonly 'Prepr-Context-utm_term'?: string;
-    readonly 'Prepr-Context-utm_content'?: string;
-    readonly 'Prepr-Context-utm_campaign'?: string;
-    readonly 'Prepr-Context-initial_referral'?: string;
-    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;
-}
-type PreprErrorCode = 'INVALID_TOKEN' | 'MISSING_TOKEN' | 'HTTP_ERROR' | 'FETCH_ERROR' | 'INVALID_RESPONSE' | 'CONTEXT_ERROR';
-
-interface PreprMiddlewareOptions {
-    /** Enable preview-mode headers (segment/AB overrides, preview bar). */
-    preview?: boolean;
-    /**
-     * Disable features app-wide. Pass the same object you give the toolbar: a
-     * disabled feature injects no header and persists no cookie, whatever the
-     * request carries.
-     */
-    features?: PreprFeatures;
-    /** Override the version reported in Prepr-Package (mainly for tests). */
-    version?: string;
-}
-
-/**
- * Structural stand-in for h3's `H3Event`, so this package needs no build-time
- * dependency on `h3`/`nuxt`. Only the fields `handlePreprRequest` uses.
- *
- * `node` ties this to Nitro's Node.js preset (the Nuxt default). Edge presets
- * expose no raw Node request/response to fold headers back onto.
- */
-interface H3EventLike {
-    node: {
-        req: {
-            url?: string;
-            headers: Record<string, string | string[] | undefined>;
-        };
-        res: {
-            /** Node's `ServerResponse.appendHeader` (Node >= 18.3). */
-            appendHeader(name: string, value: string): unknown;
-        };
-    };
-    /** Request-scoped bag shared with route handlers and Vue via `useRequestEvent`. */
-    context: Record<string, unknown>;
-}
-/** Key under which `handlePreprRequest` mirrors the forwarded Prepr `Headers`. */
-declare const PREPR_CONTEXT_KEY = "prepr";
-/**
- * Nuxt server middleware entry point — call it inside `defineEventHandler` in
- * `server/middleware/prepr.ts`:
- *
- * ```ts
- * export default defineEventHandler(event => {
- *   handlePreprRequest(event, { preview: import.meta.dev });
- * });
- * ```
- *
- * The computed Prepr headers are folded back onto the raw Node request
- * (lowercased, as Node stores them), which is what `useRequestHeaders()` and
- * downstream handlers read. The same `Headers` are mirrored onto
- * `event.context.prepr` for callers who prefer an explicit read
- * (`getPreprHeadersFromEvent`). Cookies are appended to the response.
- */
-declare function handlePreprRequest(event: H3EventLike, options?: PreprMiddlewareOptions): void;
-/**
- * Personalization headers to forward to your GraphQL fetch, from the h3 event.
- * Empty `Headers` if `handlePreprRequest` did not run, so the result is always
- * safe to spread.
- */
-declare function getPreprHeadersFromEvent(event: Pick<H3EventLike, 'context'>): Headers;
+import { P as PreprHeaders, b as PreprFeatures, c as PreprToolbarProps } from './server-8v6OHbsw.js';
+export { H as H3EventLike, d as PREPR_CONTEXT_KEY, a as PreprError, e as PreprMiddlewareOptions, f as extractAccessToken, g as getPreprHeadersFromEvent, h as handlePreprRequest, i as isPersonalizedResponse, v as validatePreprToken } from './server-8v6OHbsw.js';
 
 /** Returns the Prepr Customer ID from the request headers. */
 declare function getPreprUUID(headers: Headers): string | null;
@@ -142,23 +16,4 @@ declare function getPreprHeaders(headers: Headers): PreprHeaders;
  */
 declare function getToolbarProps(headers: Headers, token: string, features?: PreprFeatures): Promise<PreprToolbarProps>;
 
-/** 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);
-}
-/**
- * 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;
-
-export { type H3EventLike, PREPR_CONTEXT_KEY, PreprError, type PreprMiddlewareOptions, extractAccessToken, getActiveSegment, getActiveVariant, getPreprHeaders, getPreprHeadersFromEvent, getPreprUUID, getToolbarProps, handlePreprRequest, validatePreprToken };
+export { getActiveSegment, getActiveVariant, getPreprHeaders, getPreprUUID, getToolbarProps };