@magicfeedback/popup-sdk 1.0.10 → 1.0.12

package/dist/index.d.mts

@@ -12,29 +12,33 @@ interface DeepdotsInitParams {
     debug?: boolean;
     /** Lista de definiciones de popups precargadas */
     popups?: PopupDefinition[];
+    /** Optional user id to send with popup events */
+    userId?: string;
 }
 interface DeepdotsConfig {
     /** API key for authentication */
     apiKey?: string;
-    /** Base url to contact with the api */
-    baseUrl?: string;
     /** Execution mode: 'server' or 'client' */
     mode?: 'server' | 'client';
     /** Enable debug logging */
     debug?: boolean;
     /** Lista de definiciones de popups precargadas */
     popups?: PopupDefinition[];
+    /** Optional user id to send with popup events */
+    userId?: string;
 }
 /**
  * Options for configuring survey triggers
  */
 interface TriggerConfig {
-    /** Trigger type: 'time' (delay), 'scroll' (scroll percentage), 'exit' (exit intent) */
-    type: 'time' | 'scroll' | 'exit';
-    /** Value for the trigger (milliseconds for time, percentage for scroll) */
-    value?: number;
+    /** Trigger type: 'time' (delay), 'scroll' (scroll percentage), 'exit' (route exit), 'click' (element id), 'event' (host event) */
+    type: 'time' | 'scroll' | 'exit' | 'click' | 'event';
+    /** Value for the trigger (milliseconds for time, percentage for scroll, seconds for exit, element id for click, event name for event) */
+    value?: number | string;
     /** Survey ID to show when triggered */
     surveyId: string;
+    /** Optional popup definition id (used to disambiguate repeated survey ids) */
+    popupId?: string;
 }
 /**
  * Options for showing a popup
@@ -65,17 +69,18 @@ interface DeepdotsEvent {
  */
 type EventListener = (event: DeepdotsEvent) => void;
 /** Tipo de trigger específico para definiciones de popup remotas */
-type PopupTriggerType = 'time_on_page' | 'scroll' | 'exit';
+type PopupTriggerType = 'time_on_page' | 'scroll' | 'exit' | 'click' | 'event';
+type PopupTriggerConditionStatus = 'SHOWED' | 'PARTIAL' | 'COMPLETED';
+declare const POPUP_TRIGGER_CONDITION_STATUSES: PopupTriggerConditionStatus[];
 /** Condición adicional para la activación del popup */
 interface PopupTriggerCondition {
-    answered: boolean;
+    answered: PopupTriggerConditionStatus;
     cooldownDays: number;
 }
 /** Trigger asociado a la definición del popup */
 interface PopupTrigger {
     type: PopupTriggerType;
-    value: number;
-    condition?: PopupTriggerCondition[];
+    value: number | string;
 }
 /** Acción de aceptar (abrir encuesta) */
 interface PopupActionAccept {
@@ -123,7 +128,8 @@ interface PopupDefinition {
     id: string;
     title: string;
     message: string;
-    trigger: PopupTrigger;
+    triggers: PopupTrigger[];
+    cooldown?: PopupTriggerCondition[];
     actions?: PopupActions;
     surveyId: string;
     productId: string;
@@ -135,7 +141,7 @@ interface PopupRenderer {
     /** Preparar recursos si aplica */
     init?(): void;
     /** Mostrar popup */
-    show(surveyId: string, productId: string, actions: PopupActions | undefined, emit: (type: DeepdotsEventType, surveyId: string, data?: Record<string, unknown>) => void, onClose: () => void): void;
+    show(surveyId: string, productId: string, actions: PopupActions | undefined, emit: (type: DeepdotsEventType, surveyId: string, data?: Record<string, unknown>) => void, onClose: () => void, env?: string): void;
     /** Ocultar popup */
     hide(): void;
 }
@@ -154,7 +160,12 @@ declare class DeepdotsPopups {
     private popupsLoaded;
     private pendingAutoLaunch;
     private answeredSurveys;
+    private surveyProgress;
     private lastShown;
+    private surveyToPopupId;
+    private deferredExitTimers;
+    private baseUrl;
+    private env;
     /** Initialize the SDK with configuration */
     init(config: DeepdotsInitParams): void;
     /** Enable auto-launch functionality with configured triggers */
@@ -174,15 +185,30 @@ declare class DeepdotsPopups {
     /** Deriva triggers desde las definiciones de popup */
     private configureTriggersFromDefinitions;
     /** Lógica para evaluar condiciones antes de mostrar una encuesta */
-    triggerSurvey(surveyId: string): void;
+    triggerSurvey(surveyId: string, popupId?: string): void;
+    /** Trigger popups configured with trigger.type = 'event' and matching trigger.value */
+    triggerEvent(eventName: string): void;
+    private showDefinition;
     private shouldShow;
-    private evaluateCondition;
+    private matchesSegmentsPath;
+    private evaluateCooldown;
+    private evaluateLegacyCondition;
+    private hasCooldownElapsed;
     /** Marcar encuesta como contestada externamente */
     markSurveyAnswered(surveyId: string): void;
-    /** Simula fetch al servidor para obtener popups */
+    /** Queue an exit popup so it can render after navigation */
+    queueExitPopup(surveyId: string, delaySeconds: number, sourceUrl?: string, popupId?: string): void;
+    private processDeferredExitQueue;
+    private scheduleDeferredExitPopup;
+    private tryShowDeferredExitPopup;
+    private findPopupDefinition;
+    private removeDeferredExitPopup;
+    private getDeferredExitQueue;
+    private setDeferredExitQueue;
+    /** Fetch al servidor para obtener popups */
     private fetchPopupsFromServer;
-    /** Genera datos fake para pruebas en modo server */
-    private generateFakePopups;
+    /** Notifica eventos de popup a la API */
+    private postPopupEvent;
     /** Add an event listener */
     on(eventType: DeepdotsEventType, listener: EventListener): void;
     /** Remove an event listener */
@@ -201,8 +227,20 @@ declare class DeepdotsPopups {
     debug(...args: unknown[]): void;
     /** Set a custom renderer */
     setRenderer(renderer: PopupRenderer): void;
+    private normalizeUrl;
+    private safeParseUrl;
+    private mapPopupTriggerType;
+    private markSurveyProgress;
     private isPopupDefinition;
+    private isPopupTrigger;
+    private isPopupTriggerType;
+    private isPopupTriggerCondition;
+    private isLegacyPopupTriggerCondition;
+    private normalizeTriggers;
+    private normalizeCooldown;
+    private normalizeLegacyConditions;
+    private normalizePopupDefinition;
     private validatePopupDefinitions;
 }
 
-export { type DeepdotsConfig, type DeepdotsEvent, type DeepdotsEventType, DeepdotsPopups, type EventListener, type ShowOptions, type TriggerConfig };
+export { type DeepdotsConfig, type DeepdotsEvent, type DeepdotsEventType, DeepdotsPopups, type EventListener, POPUP_TRIGGER_CONDITION_STATUSES, type PopupDefinition, type PopupTrigger, type PopupTriggerCondition, type PopupTriggerConditionStatus, type ShowOptions, type TriggerConfig };

package/dist/index.d.ts

@@ -12,29 +12,33 @@ interface DeepdotsInitParams {
     debug?: boolean;
     /** Lista de definiciones de popups precargadas */
     popups?: PopupDefinition[];
+    /** Optional user id to send with popup events */
+    userId?: string;
 }
 interface DeepdotsConfig {
     /** API key for authentication */
     apiKey?: string;
-    /** Base url to contact with the api */
-    baseUrl?: string;
     /** Execution mode: 'server' or 'client' */
     mode?: 'server' | 'client';
     /** Enable debug logging */
     debug?: boolean;
     /** Lista de definiciones de popups precargadas */
     popups?: PopupDefinition[];
+    /** Optional user id to send with popup events */
+    userId?: string;
 }
 /**
  * Options for configuring survey triggers
  */
 interface TriggerConfig {
-    /** Trigger type: 'time' (delay), 'scroll' (scroll percentage), 'exit' (exit intent) */
-    type: 'time' | 'scroll' | 'exit';
-    /** Value for the trigger (milliseconds for time, percentage for scroll) */
-    value?: number;
+    /** Trigger type: 'time' (delay), 'scroll' (scroll percentage), 'exit' (route exit), 'click' (element id), 'event' (host event) */
+    type: 'time' | 'scroll' | 'exit' | 'click' | 'event';
+    /** Value for the trigger (milliseconds for time, percentage for scroll, seconds for exit, element id for click, event name for event) */
+    value?: number | string;
     /** Survey ID to show when triggered */
     surveyId: string;
+    /** Optional popup definition id (used to disambiguate repeated survey ids) */
+    popupId?: string;
 }
 /**
  * Options for showing a popup
@@ -65,17 +69,18 @@ interface DeepdotsEvent {
  */
 type EventListener = (event: DeepdotsEvent) => void;
 /** Tipo de trigger específico para definiciones de popup remotas */
-type PopupTriggerType = 'time_on_page' | 'scroll' | 'exit';
+type PopupTriggerType = 'time_on_page' | 'scroll' | 'exit' | 'click' | 'event';
+type PopupTriggerConditionStatus = 'SHOWED' | 'PARTIAL' | 'COMPLETED';
+declare const POPUP_TRIGGER_CONDITION_STATUSES: PopupTriggerConditionStatus[];
 /** Condición adicional para la activación del popup */
 interface PopupTriggerCondition {
-    answered: boolean;
+    answered: PopupTriggerConditionStatus;
     cooldownDays: number;
 }
 /** Trigger asociado a la definición del popup */
 interface PopupTrigger {
     type: PopupTriggerType;
-    value: number;
-    condition?: PopupTriggerCondition[];
+    value: number | string;
 }
 /** Acción de aceptar (abrir encuesta) */
 interface PopupActionAccept {
@@ -123,7 +128,8 @@ interface PopupDefinition {
     id: string;
     title: string;
     message: string;
-    trigger: PopupTrigger;
+    triggers: PopupTrigger[];
+    cooldown?: PopupTriggerCondition[];
     actions?: PopupActions;
     surveyId: string;
     productId: string;
@@ -135,7 +141,7 @@ interface PopupRenderer {
     /** Preparar recursos si aplica */
     init?(): void;
     /** Mostrar popup */
-    show(surveyId: string, productId: string, actions: PopupActions | undefined, emit: (type: DeepdotsEventType, surveyId: string, data?: Record<string, unknown>) => void, onClose: () => void): void;
+    show(surveyId: string, productId: string, actions: PopupActions | undefined, emit: (type: DeepdotsEventType, surveyId: string, data?: Record<string, unknown>) => void, onClose: () => void, env?: string): void;
     /** Ocultar popup */
     hide(): void;
 }
@@ -154,7 +160,12 @@ declare class DeepdotsPopups {
     private popupsLoaded;
     private pendingAutoLaunch;
     private answeredSurveys;
+    private surveyProgress;
     private lastShown;
+    private surveyToPopupId;
+    private deferredExitTimers;
+    private baseUrl;
+    private env;
     /** Initialize the SDK with configuration */
     init(config: DeepdotsInitParams): void;
     /** Enable auto-launch functionality with configured triggers */
@@ -174,15 +185,30 @@ declare class DeepdotsPopups {
     /** Deriva triggers desde las definiciones de popup */
     private configureTriggersFromDefinitions;
     /** Lógica para evaluar condiciones antes de mostrar una encuesta */
-    triggerSurvey(surveyId: string): void;
+    triggerSurvey(surveyId: string, popupId?: string): void;
+    /** Trigger popups configured with trigger.type = 'event' and matching trigger.value */
+    triggerEvent(eventName: string): void;
+    private showDefinition;
     private shouldShow;
-    private evaluateCondition;
+    private matchesSegmentsPath;
+    private evaluateCooldown;
+    private evaluateLegacyCondition;
+    private hasCooldownElapsed;
     /** Marcar encuesta como contestada externamente */
     markSurveyAnswered(surveyId: string): void;
-    /** Simula fetch al servidor para obtener popups */
+    /** Queue an exit popup so it can render after navigation */
+    queueExitPopup(surveyId: string, delaySeconds: number, sourceUrl?: string, popupId?: string): void;
+    private processDeferredExitQueue;
+    private scheduleDeferredExitPopup;
+    private tryShowDeferredExitPopup;
+    private findPopupDefinition;
+    private removeDeferredExitPopup;
+    private getDeferredExitQueue;
+    private setDeferredExitQueue;
+    /** Fetch al servidor para obtener popups */
     private fetchPopupsFromServer;
-    /** Genera datos fake para pruebas en modo server */
-    private generateFakePopups;
+    /** Notifica eventos de popup a la API */
+    private postPopupEvent;
     /** Add an event listener */
     on(eventType: DeepdotsEventType, listener: EventListener): void;
     /** Remove an event listener */
@@ -201,8 +227,20 @@ declare class DeepdotsPopups {
     debug(...args: unknown[]): void;
     /** Set a custom renderer */
     setRenderer(renderer: PopupRenderer): void;
+    private normalizeUrl;
+    private safeParseUrl;
+    private mapPopupTriggerType;
+    private markSurveyProgress;
     private isPopupDefinition;
+    private isPopupTrigger;
+    private isPopupTriggerType;
+    private isPopupTriggerCondition;
+    private isLegacyPopupTriggerCondition;
+    private normalizeTriggers;
+    private normalizeCooldown;
+    private normalizeLegacyConditions;
+    private normalizePopupDefinition;
     private validatePopupDefinitions;
 }
 
-export { type DeepdotsConfig, type DeepdotsEvent, type DeepdotsEventType, DeepdotsPopups, type EventListener, type ShowOptions, type TriggerConfig };
+export { type DeepdotsConfig, type DeepdotsEvent, type DeepdotsEventType, DeepdotsPopups, type EventListener, POPUP_TRIGGER_CONDITION_STATUSES, type PopupDefinition, type PopupTrigger, type PopupTriggerCondition, type PopupTriggerConditionStatus, type ShowOptions, type TriggerConfig };