@runbandit/sdk 3.4.0 → 3.5.1

package/dist/index.js

@@ -614,7 +614,7 @@ function matchesConversionPath(pattern, pathname) {
 }
 
 // ../shared/dist/site.js
-var SITE_TARGET_KINDS = ["text", "image"];
+var SITE_TARGET_KINDS = ["text", "image", "order"];
 var TAG_NAME = /^[a-z][a-z0-9-]*$/;
 function collapseWhitespace(raw) {
   return raw.replace(/\s+/g, " ").trim();
@@ -649,13 +649,13 @@ function parseSiteContent(config) {
 }
 function normalizeSiteTarget(target) {
   if (!SITE_TARGET_KINDS.includes(target.kind))
-    throw new Error("A target is text or an image");
+    throw new Error("A target is text, an image, or a list");
   return {
     page: requirePage(target.page),
     selector: requireText(target.selector, "The picked element has no selector"),
     tag: requireTag(target.tag),
     kind: target.kind,
-    original: requireText(target.original, "The picked element has no content to replace")
+    original: target.kind === "order" ? formatOrder(parseOrder(target.original)) : requireText(target.original, "The picked element has no content to replace")
   };
 }
 function normalizeFunnelGoal(goal) {
@@ -679,6 +679,39 @@ function goalMatchesPage(goal, pathname) {
 var MAX_ALTERNATIVES = 5;
 var MAX_TEXT_ALTERNATIVE_LENGTH = 300;
 var MAX_IMAGE_URL_LENGTH = 2048;
+var MIN_ORDER_ITEMS = 2;
+var MAX_ORDER_ITEMS = 24;
+var MAX_ORDER_KEY_LENGTH = 160;
+function formatOrder(keys) {
+  return JSON.stringify(keys);
+}
+function parseOrder(raw) {
+  let value;
+  try {
+    value = JSON.parse(raw);
+  } catch {
+    throw new Error("An order is a list of the items in the order to show them");
+  }
+  if (!Array.isArray(value) || !value.every((key) => typeof key === "string" && key.length > 0)) {
+    throw new Error("An order is a list of the items in the order to show them");
+  }
+  const keys = value;
+  if (keys.length < MIN_ORDER_ITEMS)
+    throw new Error(`A list needs at least ${MIN_ORDER_ITEMS} items`);
+  if (keys.length > MAX_ORDER_ITEMS)
+    throw new Error(`Reorder lists of at most ${MAX_ORDER_ITEMS} items`);
+  if (keys.some((key) => key.length > MAX_ORDER_KEY_LENGTH))
+    throw new Error("An item in that list is too long");
+  if (new Set(keys).size !== keys.length)
+    throw new Error("Every item in the list must be different");
+  return keys;
+}
+function isReorderOf(original, order) {
+  if (original.length !== order.length)
+    return false;
+  const remaining = new Set(original);
+  return order.every((key) => remaining.delete(key));
+}
 var SUGGESTED_SITE_EXPERIMENTS = 3;
 function moreExperimentsSentence(running, suggested) {
   const noun = (count) => count === 1 ? "experiment" : "experiments";
@@ -707,6 +740,8 @@ function parseAlternative(kind, raw) {
     }
     return text;
   }
+  if (kind === "order")
+    return formatOrder(parseOrder(raw));
   const trimmed = raw.trim();
   if (trimmed.length > MAX_IMAGE_URL_LENGTH)
     throw new Error("That image address is too long");
@@ -722,8 +757,8 @@ function parseAlternative(kind, raw) {
 }
 var PICK_CHANNEL = "bandit-pick";
 var PICK_PROTOCOL_VERSION = 1;
-var PICK_MODES = ["idle", "target", "goal-click"];
-var PICK_REJECTIONS = ["not-text-or-image", "has-markup", "not-clickable", "no-selector"];
+var PICK_MODES = ["idle", "target", "order", "goal-click"];
+var PICK_REJECTIONS = ["not-text-or-image", "has-markup", "not-a-list", "not-clickable", "no-selector"];
 var PICK_TOKEN_PREFIX = "bpick_";
 function pickEnvelope(msg) {
   return { channel: PICK_CHANNEL, v: PICK_PROTOCOL_VERSION, msg };
@@ -806,6 +841,20 @@ function parsePanelMessage(data) {
 // ../shared/dist/site-platforms.js
 var SITE_PLATFORMS = [
   { id: "shopify", label: "Shopify", path: "shopify", codeBox: "", steps: [] },
+  {
+    id: "shopify_theme",
+    label: "Shopify",
+    path: "script",
+    codeBox: "Online Store, Themes, Edit code, layout/theme.liquid, just before </head>.",
+    steps: [
+      "In your Shopify admin open Online Store, then Themes.",
+      "On your live theme click the three dots, then Edit code.",
+      "Open layout/theme.liquid.",
+      "Paste the script on the line just before </head>.",
+      "Click Save.",
+      "Then add the purchase pixel below, so Bandit learns from orders."
+    ]
+  },
   {
     id: "webflow",
     label: "Webflow",
@@ -1148,6 +1197,9 @@ function touchFromPage(page) {
   const trackingParam = Object.keys(TRACKING_PARAM_SOURCES).find((name) => params.has(name));
   if (trackingParam)
     touch.trackingParam = trackingParam;
+  const klaviyoExchangeId = params.get("_kx");
+  if (klaviyoExchangeId)
+    touch.klaviyoExchangeId = klaviyoExchangeId;
   const referrerHost = normalizeHost(safeUrl(page.referrer)?.hostname);
   if (referrerHost && referrerHost !== normalizeHost(url.hostname))
     touch.referrerHost = referrerHost;
@@ -1160,7 +1212,8 @@ function touchSignature(touch) {
     touch.utmCampaign ?? "",
     touch.utmContent ?? "",
     touch.trackingParam ?? "",
-    touch.referrerHost ?? ""
+    touch.referrerHost ?? "",
+    touch.klaviyoExchangeId ?? ""
   ]);
 }
 function shouldReportTouch(touch, stored, sessionId, now) {
@@ -1201,6 +1254,100 @@ function sourceOf(arrival) {
   return { key: "ch:tagged", label: "Tagged" };
 }
 
+// ../shared/dist/cdp-aliases.js
+var CDP_SOURCES = ["segment", "rudderstack", "posthog"];
+var MAX_CDP_EXTERNAL_ID_LENGTH = 256;
+var RUDDERSTACK_ENCRYPTED_PREFIX = "RS_ENC_v3_";
+var RUDDERSTACK_LEGACY_ENCRYPTED_PREFIX = "RudderEncrypt:";
+function decoded(raw) {
+  try {
+    return decodeURIComponent(raw);
+  } catch {
+    return raw;
+  }
+}
+function jsonValue(text) {
+  try {
+    return JSON.parse(text);
+  } catch {
+    return void 0;
+  }
+}
+function nonEmpty(value) {
+  return typeof value === "string" && value.length > 0 ? value : null;
+}
+function plainOrQuoted(raw) {
+  const text = decoded(raw);
+  return nonEmpty(text.startsWith('"') ? jsonValue(text) : text);
+}
+function rudderstackValue(raw) {
+  const text = plainOrQuoted(raw);
+  if (text === null || text.startsWith(RUDDERSTACK_LEGACY_ENCRYPTED_PREFIX))
+    return null;
+  if (!text.startsWith(RUDDERSTACK_ENCRYPTED_PREFIX))
+    return text;
+  try {
+    return nonEmpty(jsonValue(atob(text.slice(RUDDERSTACK_ENCRYPTED_PREFIX.length))));
+  } catch {
+    return null;
+  }
+}
+function posthogDistinctId(raw) {
+  const parsed = jsonValue(decoded(raw));
+  if (typeof parsed !== "object" || parsed === null)
+    return null;
+  const state = parsed;
+  const deviceId = nonEmpty(state.$device_id);
+  if (deviceId !== null)
+    return deviceId;
+  return state.$user_state === "identified" ? null : nonEmpty(state.distinct_id);
+}
+var CDP_SOURCE_REGISTRY = [
+  { source: "segment", key: /^ajs_anonymous_id$/, parse: plainOrQuoted },
+  { source: "rudderstack", key: /^rl_anonymous_id$/, parse: rudderstackValue },
+  { source: "posthog", key: /^ph_.+_posthog$/, parse: posthogDistinctId }
+];
+function cookiePairs(header) {
+  const pairs = [];
+  for (const part of header.split(";")) {
+    const index = part.indexOf("=");
+    if (index === -1)
+      continue;
+    pairs.push([part.slice(0, index).trim(), part.slice(index + 1).trim()]);
+  }
+  return pairs;
+}
+function storagePairs(storage) {
+  const pairs = [];
+  try {
+    for (let i = 0; i < (storage?.length ?? 0); i++) {
+      const key = storage.key(i);
+      const value = key === null ? null : storage.getItem(key);
+      if (key !== null && value !== null)
+        pairs.push([key, value]);
+    }
+  } catch {
+    return pairs;
+  }
+  return pairs;
+}
+function readCdpAliases(cookieHeader, storage) {
+  const candidates = [...cookiePairs(cookieHeader), ...storagePairs(storage)];
+  const aliases = [];
+  for (const { source, key, parse } of CDP_SOURCE_REGISTRY) {
+    for (const [name, raw] of candidates) {
+      if (!key.test(name))
+        continue;
+      const externalId = parse(raw);
+      if (externalId === null || externalId.length > MAX_CDP_EXTERNAL_ID_LENGTH)
+        continue;
+      aliases.push({ source, externalId });
+      break;
+    }
+  }
+  return aliases;
+}
+
 // ../shared/dist/payout-unit.js
 var PAYOUT_UNITS = ["count", "revenue", "margin"];
 var NEW_PAYOUT_UNIT = "count";
@@ -1246,6 +1393,24 @@ function formatPayout(unit, value) {
   return isCurrencyUnit(unit) ? USD.format(value) : value.toLocaleString("en-US", { maximumFractionDigits: 2 });
 }
 
+// ../shared/dist/trial-rule.js
+var TRIAL_RULES = ["served", "exposure"];
+function isTrialRule(value) {
+  return value === "served" || value === "exposure";
+}
+function trialRuleFor({ target, requested }) {
+  if (requested)
+    return requested;
+  return target ? "exposure" : "served";
+}
+function trialRuleOf(experiment) {
+  return experiment.trialOn ?? "served";
+}
+var TRIAL_RULE_COPY = {
+  served: "Counts a trial when served",
+  exposure: "Counts a trial when seen"
+};
+
 // src/client.ts
 var ARRIVAL_KEY = "bandits_arrival";
 function readStoredArrival(storage) {
@@ -1257,6 +1422,22 @@ function readStoredArrival(storage) {
     return null;
   }
 }
+var CDP_ALIASES_KEY = "bandits_cdp_aliases";
+function readSentAliases(storage, visitorId) {
+  try {
+    const parsed = JSON.parse(storage?.getItem(CDP_ALIASES_KEY) ?? "null");
+    return parsed?.visitorId === visitorId && typeof parsed.sent === "object" && parsed.sent !== null ? parsed.sent : {};
+  } catch {
+    return {};
+  }
+}
+function readCookieHeader() {
+  try {
+    return document.cookie ?? "";
+  } catch {
+    return "";
+  }
+}
 var BanditsRequestError = class extends Error {
   status;
   constructor(message, status) {
@@ -1279,6 +1460,8 @@ var BanditsClient = class {
   namedEventQueue = [];
   sessionId;
   visitorId;
+  exposureQueue = [];
+  exposedIds = /* @__PURE__ */ new Set();
   flushTimer;
   constructor(config) {
     this.config = {
@@ -1292,6 +1475,32 @@ var BanditsClient = class {
     this.visitorId = config.visitorId ?? getOrCreateVisitorId(defaultSessionStorage());
     this.startBatchFlush();
     if (config.captureArrival !== false) void this.reportArrival();
+    if (config.captureCdpAliases !== false) void this.reportCdpAliases();
+  }
+  async reportCdpAliases() {
+    if (typeof document === "undefined") return false;
+    const storage = defaultSessionStorage();
+    const sent = readSentAliases(storage, this.visitorId);
+    const fresh = readCdpAliases(readCookieHeader(), storage).filter(({ source, externalId }) => sent[source] !== externalId);
+    if (fresh.length === 0) return false;
+    try {
+      await this.aliasVisitor(fresh);
+    } catch {
+      return false;
+    }
+    const record = { visitorId: this.visitorId, sent: { ...sent, ...Object.fromEntries(fresh.map((a) => [a.source, a.externalId])) } };
+    try {
+      storage?.setItem(CDP_ALIASES_KEY, JSON.stringify(record));
+    } catch {
+      return true;
+    }
+    return true;
+  }
+  async aliasVisitor(aliases) {
+    const response = await this.makeRequest("/aliases", "POST", { visitorId: this.visitorId, aliases });
+    if (!response.success) {
+      throw requestError(response, "Failed to alias visitor");
+    }
   }
   async reportArrival() {
     if (typeof location === "undefined" || typeof document === "undefined") return false;
@@ -1336,7 +1545,8 @@ var BanditsClient = class {
       experimentId,
       userId,
       config: assignment.treatment?.config || {},
-      funnelId: assignment.funnelId
+      funnelId: assignment.funnelId,
+      trialOn: assignment.trialOn
     };
   }
   trackNamedEvent(event, opts) {
@@ -1373,6 +1583,12 @@ var BanditsClient = class {
     }
   }
   async flush() {
+    const results = await Promise.allSettled([this.flushNamedEvents(), this.flushExposures()]);
+    for (const result of results) {
+      if (result.status === "rejected") throw result.reason;
+    }
+  }
+  async flushNamedEvents() {
     const namedEvents = [...this.namedEventQueue];
     this.namedEventQueue = [];
     if (namedEvents.length === 0) return;
@@ -1391,14 +1607,75 @@ var BanditsClient = class {
       throw error;
     }
   }
-  async identify(anonymousId, identifiedUserId, mergeReason) {
+  async flushExposures() {
+    const exposures = [...this.exposureQueue];
+    this.exposureQueue = [];
+    if (exposures.length === 0) return;
+    try {
+      await fetch(`${this.normalizeApiUrl()}/exposures`, {
+        method: "POST",
+        headers: {
+          "Authorization": `Bearer ${this.config.apiKey}`,
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify({ exposures }),
+        keepalive: true
+      });
+    } catch (error) {
+      this.exposureQueue.unshift(...exposures);
+      throw error;
+    }
+  }
+  exposed(assignmentId, opts) {
+    if (this.exposedIds.has(assignmentId)) return;
+    this.exposedIds.add(assignmentId);
+    this.exposureQueue.push({ assignmentId, exposedAt: Date.now() });
+    if (opts?.immediate || this.exposureQueue.length >= this.config.batchSize) {
+      this.flushExposures().catch(console.error);
+    }
+  }
+  observeExposure(assignmentId, element, opts) {
+    if (typeof IntersectionObserver === "undefined") return () => {
+    };
+    const threshold = opts?.threshold ?? 0.5;
+    const dwellMs = opts?.dwellMs ?? 1e3;
+    let dwell;
+    const stop = () => {
+      clearTimeout(dwell);
+      dwell = void 0;
+    };
+    const observer = new IntersectionObserver(
+      (entries) => {
+        const entry = entries[entries.length - 1];
+        if (!entry) return;
+        const coversViewport = entry.rootBounds != null && entry.intersectionRect.height >= threshold * entry.rootBounds.height;
+        if (entry.isIntersecting && (entry.intersectionRatio >= threshold || coversViewport)) {
+          dwell ??= setTimeout(() => {
+            this.exposed(assignmentId);
+            disconnect();
+          }, dwellMs);
+        } else {
+          stop();
+        }
+      },
+      { threshold: Array.from({ length: 21 }, (_, i) => i / 20) }
+    );
+    const disconnect = () => {
+      stop();
+      observer.disconnect();
+    };
+    observer.observe(element);
+    return disconnect;
+  }
+  async identify(anonymousId, identifiedUserId, mergeReason, options) {
     const response = await this.makeRequest(
       "/identify",
       "POST",
       {
         anonymousId,
         identifiedUserId,
-        mergeReason: mergeReason || "manual"
+        mergeReason: mergeReason || "manual",
+        ...options?.email ? { email: options.email } : {}
       }
     );
     if (!response.success) {
@@ -1412,6 +1689,7 @@ var BanditsClient = class {
     }
   }
   async trackFunnelReward(funnelId, userId, value) {
+    await this.flushExposures().catch(() => void 0);
     const response = await this.makeRequest(
       `/funnels/${funnelId}/reward`,
       "POST",
@@ -1725,6 +2003,8 @@ export {
   BanditsClient as BanditClient,
   BanditsClient,
   BanditsRequestError,
+  CDP_SOURCES,
+  CDP_SOURCE_REGISTRY,
   CHANNEL_LABELS,
   CHANNEL_RULES,
   CONTENT_TYPE_BY_KIND,
@@ -1739,12 +2019,16 @@ export {
   FunnelStatus,
   MAX_ALTERNATIVES,
   MAX_ARRIVAL_VALUE_LENGTH,
+  MAX_CDP_EXTERNAL_ID_LENGTH,
   MAX_IMAGE_URL_LENGTH,
   MAX_ORDERING_ITEMS,
+  MAX_ORDER_ITEMS,
+  MAX_ORDER_KEY_LENGTH,
   MAX_RAW_TOUCH_VALUE_LENGTH,
   MAX_REFERRER_HOST_LENGTH,
   MAX_TEXT_ALTERNATIVE_LENGTH,
   MIN_ORDERING_ITEMS,
+  MIN_ORDER_ITEMS,
   NEW_PAYOUT_UNIT,
   PASS_THROUGH_HOSTS,
   PAYOUT_UNITS,
@@ -1768,6 +2052,8 @@ export {
   SUGGESTED_SITE_EXPERIMENTS,
   SnapshotClient,
   TRACKING_PARAM_SOURCES,
+  TRIAL_RULES,
+  TRIAL_RULE_COPY,
   UNKNOWN_SOURCE_KEY,
   UTM_PARAMS,
   VISITOR_COOKIE,
@@ -1781,6 +2067,7 @@ export {
   extractEmailLinks,
   extractSlotNames,
   extractSubdomain,
+  formatOrder,
   formatPayout,
   generateId,
   generateSubdomain,
@@ -1796,8 +2083,10 @@ export {
   isPassThroughHost,
   isPayoutUnit,
   isPlacement,
+  isReorderOf,
   isShopifyCdnUrl,
   isSlotBinding,
+  isTrialRule,
   isValidEmail,
   isValidSubdomain,
   kindOfPlacement,
@@ -1814,6 +2103,7 @@ export {
   normalizeTreatmentWeights,
   parseAlternative,
   parseDecisions,
+  parseOrder,
   parsePanelMessage,
   parsePickerMessage,
   parseSiteContent,
@@ -1824,6 +2114,7 @@ export {
   pickStep,
   pickTreatment,
   platformById,
+  readCdpAliases,
   readCookie,
   renderEmail,
   renderEmailDocument,
@@ -1842,6 +2133,8 @@ export {
   targetMatchesPage,
   touchFromPage,
   touchSignature,
+  trialRuleFor,
+  trialRuleOf,
   uniformFor,
   validateTreatmentWeights,
   verifyEmailToken