@perspective-ai/sdk 1.0.1 → 1.1.2

package/dist/index.d.ts

@@ -8,6 +8,18 @@ export { BRAND_KEYS, BrandKey, CURRENT_FEATURES, DATA_ATTRS, FEATURES, MESSAGE_T
  */
 
 type EmbedType = "widget" | "popup" | "slider" | "float" | "fullpage" | "chat";
+type TriggerConfig = {
+    type: "timeout";
+    delay: number;
+} | {
+    type: "exit-intent";
+};
+type TriggerType = TriggerConfig["type"];
+type ShowOnce = "session" | "visitor" | false;
+interface AutoOpenConfig {
+    trigger: TriggerConfig;
+    showOnce?: ShowOnce;
+}
 /** Brand colors that can be passed via embed code */
 interface BrandColors {
     /** Primary accent color (buttons, links, focus states) */
@@ -35,6 +47,8 @@ interface EmbedConfig {
     theme?: ThemeValue;
     /** Override the default host (defaults to https://getperspective.ai) */
     host?: string;
+    /** Auto-open trigger configuration (popup only) */
+    autoOpen?: AutoOpenConfig;
     /** Callback when embed is ready */
     onReady?: () => void;
     /** Callback when interview is submitted/completed */
@@ -137,6 +151,51 @@ declare const createChatBubble: typeof createFloatBubble;
 
 declare function createFullpage(config: EmbedConfig): EmbedHandle;
 
+/**
+ * Auto-open trigger system for popup embeds.
+ *
+ * Supports:
+ * - Timeout: Open after a delay (ms)
+ * - Exit intent: Open when user moves cursor above viewport
+ *
+ * Show-once dedup:
+ * - "session" -> sessionStorage
+ * - "visitor" -> localStorage
+ * - false -> always show
+ */
+
+/**
+ * Parse a trigger attribute value into a TriggerConfig.
+ *
+ * Formats:
+ * - "timeout:5000" -> { type: "timeout", delay: 5000 }
+ * - "exit-intent"  -> { type: "exit-intent" }
+ */
+declare function parseTriggerAttr(value: string): TriggerConfig;
+/**
+ * Set up a trigger that calls `callback` when fired.
+ * Returns a cleanup function to teardown the trigger.
+ */
+declare function setupTrigger(config: TriggerConfig, callback: () => void): () => void;
+/**
+ * Parse a show-once attribute value into a ShowOnce.
+ *
+ * Formats:
+ * - "session"  -> "session"
+ * - "visitor"  -> "visitor"
+ * - "false"    -> false
+ * - anything else -> defaults to "session"
+ */
+declare function parseShowOnceAttr(value: string | null): ShowOnce;
+/**
+ * Check if the popup should be shown based on show-once dedup.
+ */
+declare function shouldShow(researchId: string, showOnce: ShowOnce): boolean;
+/**
+ * Mark the popup as shown for dedup purposes.
+ */
+declare function markShown(researchId: string, showOnce: ShowOnce): void;
+
 /**
  * Embed SDK configuration
  * SSR-safe - DOM access is guarded and lazy
@@ -152,4 +211,4 @@ declare function configure(config: SDKConfig): void;
  */
 declare function getConfig(): SDKConfig;
 
-export { type BrandColors, type EmbedConfig, type EmbedError, type EmbedHandle, type EmbedInstance, type EmbedType, type FloatHandle, type ModalHandle, type SDKConfig, type ThemeConfig, ThemeValue, configure, createChatBubble, createFloatBubble, createFullpage, createWidget, getConfig, openPopup, openSlider };
+export { type AutoOpenConfig, type BrandColors, type EmbedConfig, type EmbedError, type EmbedHandle, type EmbedInstance, type EmbedType, type FloatHandle, type ModalHandle, type SDKConfig, type ShowOnce, type ThemeConfig, ThemeValue, type TriggerConfig, type TriggerType, configure, createChatBubble, createFloatBubble, createFullpage, createWidget, getConfig, markShown, openPopup, openSlider, parseShowOnceAttr, parseTriggerAttr, setupTrigger, shouldShow };

package/dist/index.js

@@ -56,7 +56,7 @@ if (hasDom()) {
 }
 
 // src/constants.ts
-var SDK_VERSION = "1.0.0";
+var SDK_VERSION = "1.1.2";
 var FEATURES = {
   RESIZE: 1 << 0,
   // 0b0001
@@ -85,26 +85,9 @@ var BRAND_KEYS = {
   darkBg: "brand.dark.bg",
   darkText: "brand.dark.text"
 };
-var UTM_PARAMS = [
-  "utm_source",
-  "utm_medium",
-  "utm_campaign",
-  "utm_term",
-  "utm_content"
-];
 var RESERVED_PARAMS = /* @__PURE__ */ new Set([
-  PARAM_KEYS.embed,
-  PARAM_KEYS.embedType,
-  PARAM_KEYS.theme,
-  BRAND_KEYS.primary,
-  BRAND_KEYS.secondary,
-  BRAND_KEYS.bg,
-  BRAND_KEYS.text,
-  BRAND_KEYS.darkPrimary,
-  BRAND_KEYS.darkSecondary,
-  BRAND_KEYS.darkBg,
-  BRAND_KEYS.darkText,
-  ...UTM_PARAMS
+  ...Object.values(PARAM_KEYS),
+  ...Object.values(BRAND_KEYS)
 ]);
 var DATA_ATTRS = {
   widget: "data-perspective-widget",
@@ -119,7 +102,9 @@ var DATA_ATTRS = {
   brand: "data-perspective-brand",
   brandDark: "data-perspective-brand-dark",
   theme: "data-perspective-theme",
-  noStyle: "data-perspective-no-style"
+  noStyle: "data-perspective-no-style",
+  autoOpen: "data-perspective-auto-open",
+  showOnce: "data-perspective-show-once"
 };
 var MESSAGE_TYPES = {
   // SDK -> Iframe (initialization)
@@ -148,7 +133,8 @@ var THEME_VALUES = {
   system: "system"
 };
 var STORAGE_KEYS = {
-  anonId: "perspective-anon-id"
+  anonId: "perspective-anon-id",
+  triggerShown: "perspective-trigger-shown"
 };
 
 // src/utils.ts
@@ -218,13 +204,12 @@ function getOrCreateAnonId() {
     return crypto.randomUUID();
   }
 }
-function getUtmParams() {
+function getParentSearchParams() {
   if (!hasDom()) return {};
   const params = {};
   const searchParams = new URLSearchParams(window.location.search);
-  for (const key of UTM_PARAMS) {
-    const value = searchParams.get(key);
-    if (value) {
+  for (const [key, value] of searchParams.entries()) {
+    if (!RESERVED_PARAMS.has(key)) {
       params[key] = value;
     }
   }
@@ -247,8 +232,8 @@ function buildIframeUrl(researchId, type, host, customParams, brand, themeOverri
   } else {
     url.searchParams.set(PARAM_KEYS.theme, themeOverride || THEME_VALUES.light);
   }
-  const utmParams = getUtmParams();
-  for (const [key, value] of Object.entries(utmParams)) {
+  const parentParams = getParentSearchParams();
+  for (const [key, value] of Object.entries(parentParams)) {
     url.searchParams.set(key, value);
   }
   const setColor = (key, color) => {
@@ -1570,6 +1555,74 @@ function createFullpage(config) {
   };
 }
 
-export { BRAND_KEYS, CURRENT_FEATURES, DATA_ATTRS, FEATURES, MESSAGE_TYPES, PARAM_KEYS, SDK_VERSION, THEME_VALUES, configure, createChatBubble, createFloatBubble, createFullpage, createWidget, getConfig, openPopup, openSlider };
+// src/triggers.ts
+function parseTriggerAttr(value) {
+  const trimmed = value.trim();
+  if (trimmed.startsWith("timeout:")) {
+    const delay = parseInt(trimmed.slice("timeout:".length), 10);
+    if (isNaN(delay) || delay < 0) {
+      throw new Error(`Invalid timeout delay: "${value}"`);
+    }
+    return { type: "timeout", delay };
+  }
+  if (trimmed === "timeout") {
+    return { type: "timeout", delay: 5e3 };
+  }
+  if (trimmed === "exit-intent") {
+    return { type: "exit-intent" };
+  }
+  throw new Error(
+    `Unknown trigger type: "${value}". Expected "timeout:<ms>" or "exit-intent".`
+  );
+}
+function setupTrigger(config, callback) {
+  if (config.type === "timeout") {
+    const timer = setTimeout(callback, config.delay);
+    return () => clearTimeout(timer);
+  }
+  if (config.type === "exit-intent") {
+    const handler = (e) => {
+      if (e.clientY <= 0) {
+        callback();
+        document.removeEventListener("mouseleave", handler);
+      }
+    };
+    document.addEventListener("mouseleave", handler);
+    return () => document.removeEventListener("mouseleave", handler);
+  }
+  const _exhaustive = config;
+  throw new Error(
+    `Unknown trigger type: ${_exhaustive.type}`
+  );
+}
+function storageKey(researchId) {
+  return `${STORAGE_KEYS.triggerShown}:${researchId}`;
+}
+function parseShowOnceAttr(value) {
+  if (!value) return "session";
+  const trimmed = value.trim();
+  if (trimmed === "visitor") return "visitor";
+  if (trimmed === "false") return false;
+  return "session";
+}
+function shouldShow(researchId, showOnce) {
+  if (showOnce === false) return true;
+  try {
+    const storage = showOnce === "visitor" ? localStorage : sessionStorage;
+    return storage.getItem(storageKey(researchId)) === null;
+  } catch {
+    return true;
+  }
+}
+function markShown(researchId, showOnce) {
+  if (showOnce === false) return;
+  try {
+    const storage = showOnce === "visitor" ? localStorage : sessionStorage;
+    storage.setItem(storageKey(researchId), "1");
+  } catch {
+  }
+}
+
+export { BRAND_KEYS, CURRENT_FEATURES, DATA_ATTRS, FEATURES, MESSAGE_TYPES, PARAM_KEYS, SDK_VERSION, THEME_VALUES, configure, createChatBubble, createFloatBubble, createFullpage, createWidget, getConfig, markShown, openPopup, openSlider, parseShowOnceAttr, parseTriggerAttr, setupTrigger, shouldShow };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map