@magicfeedback/popup-sdk 1.3.0 → 1.5.0

package/dist/react-native.d.mts

@@ -162,6 +162,29 @@ interface DeepdotsInitParams {
      * `setContactAttributes` after init (sends only when values changed from the last sync).
      */
     contactAttributes?: Record<string, string | number | boolean>;
+    /**
+     * Whether the SDK renders the popup "modal" (card + backdrop + positioning) around the survey.
+     * Default `true`. Only affects React Native (the survey WebView HTML); the web DOM popup is
+     * unaffected. With `false` the survey is delivered transparent and edge-to-edge so the host
+     * mounts its own Modal/container and controls the styling — avoids the "double modal" when the
+     * host already wraps the WebView. The survey stays fully functional (bridge, form, nav buttons,
+     * close). Ver `ReactNativePopupRenderer`.
+     */
+    renderChrome?: boolean;
+    /**
+     * Barra de progreso ("Question X of Y" + barra) en la cabecera del popup. Si se omite,
+     * manda el `showProgressBar` que la plataforma configura en el estilo del survey; `true` o
+     * `false` lo fuerzan desde el host. Solo se pinta con más de una página, fuera de la
+     * pantalla de inicio y antes de completar, igual que en la web de surveys.
+     */
+    showProgressBar?: boolean;
+    /**
+     * CSS propio del host, inyectado como último bloque de estilos del popup: gana en cascada
+     * sobre el del SDK y sobre el de `@magicfeedback/native` sin tener que tocar ninguno. Es la
+     * vía para reestilar el área de preguntas (enunciados, opciones, escalas) por integración,
+     * en vez de cambiar los defaults que comparten todos los clientes.
+     */
+    surveyCss?: string;
 }
 /**
  * Options for configuring survey triggers
@@ -239,11 +262,26 @@ interface PopupStyle {
     font?: PopupFont;
 }
 
+/**
+ * Ajustes de presentación que no vienen del estilo del popup. Van agrupados para no seguir
+ * alargando la lista posicional de `show`, que ya arrastra doce parámetros.
+ */
+interface PopupRenderOptions {
+    /**
+     * Título de la cabecera: el `title` de la definición del popup, tal cual llega de la API.
+     * Varía por popup y vacío es un valor válido (la cabecera se queda solo con la X).
+     */
+    title?: string;
+    /** Barra de progreso: `undefined` deja decidir a la plataforma, `true`/`false` la fuerzan. */
+    showProgressBar?: boolean;
+    /** CSS del host, inyectado el último: gana sobre el del SDK y el de `@magicfeedback/native`. */
+    surveyCss?: string;
+}
 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, env?: string, userId?: string, style?: PopupStyle, sessionId?: string, miniService?: string, analyticsFeedbackSessionId?: string): void;
+    show(surveyId: string, productId: string, actions: PopupActions | undefined, emit: (type: DeepdotsEventType, surveyId: string, data?: Record<string, unknown>) => void, onClose: () => void, env?: string, userId?: string, style?: PopupStyle, sessionId?: string, miniService?: string, analyticsFeedbackSessionId?: string, renderChrome?: boolean, options?: PopupRenderOptions): void;
     /** Ocultar popup */
     hide(): void;
 }
@@ -323,6 +361,12 @@ declare class DeepdotsPopups {
     private deferredExitTimers;
     private baseUrl;
     private env;
+    /** Si el SDK pinta el "modal" del popup (RN). Default true; false = el host lo envuelve. */
+    private renderChrome;
+    /** Barra de progreso. undefined = la decide la plataforma (style.showProgressBar). */
+    private showProgressBar;
+    /** CSS del host inyectado al final de los estilos del popup. */
+    private surveyCss;
     /** Identidad + sesión (Fase 1 tracking). Null hasta init(). */
     private tracking;
     /** Capa de analytics (canal separado del feedback). Null hasta init(). */
@@ -394,6 +438,15 @@ declare class DeepdotsPopups {
     trackFindabilityFriction(frictionTopic: string, params?: Record<string, unknown>): void;
     /** Funnel: un paso del embudo, correlacionado por `taskId`. El backend reconstruye conversión/drop-off/tiempo. */
     trackFunnelStep(funnel: string, step: string, taskId: string, params?: Record<string, unknown>): void;
+    /**
+     * Product Effectiveness: una interacción significativa del usuario (`interaction_type` es la
+     * dimensión de agrupación, p. ej. `get_help`, `homepage`, `contact_support`).
+     *
+     * Existe como evento RESERVADO para que la convención no la invente cada host: un `track()`
+     * custom acaba como `deepdots_event_…` y no lo cuenta la analítica de effectiveness.
+     * Un `interactionType` vacío se descarta con warning (no aporta dato agrupable).
+     */
+    trackMeaningfulInteraction(interactionType: string, params?: Record<string, unknown>): void;
     /**
      * Messaging (#18–22): registra una etapa del funnel de una notificación (push/in-app).
      * No-op si tracking off. El evento se descarta (con warning) si el `channel` no es válido,
@@ -612,7 +665,7 @@ declare class ReactNativePopupRenderer implements PopupRenderer {
     private partialEmitted;
     constructor(options?: ReactNativeRendererOptions);
     init(): void;
-    show(surveyId: string, productId: string, actions: PopupActions | undefined, emit: EmitFn, onClose: () => void, env?: string, userId?: string, style?: PopupStyle, sessionId?: string, miniService?: string, analyticsFeedbackSessionId?: string): void;
+    show(surveyId: string, productId: string, actions: PopupActions | undefined, emit: EmitFn, onClose: () => void, env?: string, userId?: string, style?: PopupStyle, sessionId?: string, miniService?: string, analyticsFeedbackSessionId?: string, renderChrome?: boolean, options?: PopupRenderOptions): void;
     hide(): void;
     /**
      * El host la conecta al `onMessage` del WebView. Traduce los mensajes del survey a

package/dist/react-native.d.ts

@@ -162,6 +162,29 @@ interface DeepdotsInitParams {
      * `setContactAttributes` after init (sends only when values changed from the last sync).
      */
     contactAttributes?: Record<string, string | number | boolean>;
+    /**
+     * Whether the SDK renders the popup "modal" (card + backdrop + positioning) around the survey.
+     * Default `true`. Only affects React Native (the survey WebView HTML); the web DOM popup is
+     * unaffected. With `false` the survey is delivered transparent and edge-to-edge so the host
+     * mounts its own Modal/container and controls the styling — avoids the "double modal" when the
+     * host already wraps the WebView. The survey stays fully functional (bridge, form, nav buttons,
+     * close). Ver `ReactNativePopupRenderer`.
+     */
+    renderChrome?: boolean;
+    /**
+     * Barra de progreso ("Question X of Y" + barra) en la cabecera del popup. Si se omite,
+     * manda el `showProgressBar` que la plataforma configura en el estilo del survey; `true` o
+     * `false` lo fuerzan desde el host. Solo se pinta con más de una página, fuera de la
+     * pantalla de inicio y antes de completar, igual que en la web de surveys.
+     */
+    showProgressBar?: boolean;
+    /**
+     * CSS propio del host, inyectado como último bloque de estilos del popup: gana en cascada
+     * sobre el del SDK y sobre el de `@magicfeedback/native` sin tener que tocar ninguno. Es la
+     * vía para reestilar el área de preguntas (enunciados, opciones, escalas) por integración,
+     * en vez de cambiar los defaults que comparten todos los clientes.
+     */
+    surveyCss?: string;
 }
 /**
  * Options for configuring survey triggers
@@ -239,11 +262,26 @@ interface PopupStyle {
     font?: PopupFont;
 }
 
+/**
+ * Ajustes de presentación que no vienen del estilo del popup. Van agrupados para no seguir
+ * alargando la lista posicional de `show`, que ya arrastra doce parámetros.
+ */
+interface PopupRenderOptions {
+    /**
+     * Título de la cabecera: el `title` de la definición del popup, tal cual llega de la API.
+     * Varía por popup y vacío es un valor válido (la cabecera se queda solo con la X).
+     */
+    title?: string;
+    /** Barra de progreso: `undefined` deja decidir a la plataforma, `true`/`false` la fuerzan. */
+    showProgressBar?: boolean;
+    /** CSS del host, inyectado el último: gana sobre el del SDK y el de `@magicfeedback/native`. */
+    surveyCss?: string;
+}
 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, env?: string, userId?: string, style?: PopupStyle, sessionId?: string, miniService?: string, analyticsFeedbackSessionId?: string): void;
+    show(surveyId: string, productId: string, actions: PopupActions | undefined, emit: (type: DeepdotsEventType, surveyId: string, data?: Record<string, unknown>) => void, onClose: () => void, env?: string, userId?: string, style?: PopupStyle, sessionId?: string, miniService?: string, analyticsFeedbackSessionId?: string, renderChrome?: boolean, options?: PopupRenderOptions): void;
     /** Ocultar popup */
     hide(): void;
 }
@@ -323,6 +361,12 @@ declare class DeepdotsPopups {
     private deferredExitTimers;
     private baseUrl;
     private env;
+    /** Si el SDK pinta el "modal" del popup (RN). Default true; false = el host lo envuelve. */
+    private renderChrome;
+    /** Barra de progreso. undefined = la decide la plataforma (style.showProgressBar). */
+    private showProgressBar;
+    /** CSS del host inyectado al final de los estilos del popup. */
+    private surveyCss;
     /** Identidad + sesión (Fase 1 tracking). Null hasta init(). */
     private tracking;
     /** Capa de analytics (canal separado del feedback). Null hasta init(). */
@@ -394,6 +438,15 @@ declare class DeepdotsPopups {
     trackFindabilityFriction(frictionTopic: string, params?: Record<string, unknown>): void;
     /** Funnel: un paso del embudo, correlacionado por `taskId`. El backend reconstruye conversión/drop-off/tiempo. */
     trackFunnelStep(funnel: string, step: string, taskId: string, params?: Record<string, unknown>): void;
+    /**
+     * Product Effectiveness: una interacción significativa del usuario (`interaction_type` es la
+     * dimensión de agrupación, p. ej. `get_help`, `homepage`, `contact_support`).
+     *
+     * Existe como evento RESERVADO para que la convención no la invente cada host: un `track()`
+     * custom acaba como `deepdots_event_…` y no lo cuenta la analítica de effectiveness.
+     * Un `interactionType` vacío se descarta con warning (no aporta dato agrupable).
+     */
+    trackMeaningfulInteraction(interactionType: string, params?: Record<string, unknown>): void;
     /**
      * Messaging (#18–22): registra una etapa del funnel de una notificación (push/in-app).
      * No-op si tracking off. El evento se descarta (con warning) si el `channel` no es válido,
@@ -612,7 +665,7 @@ declare class ReactNativePopupRenderer implements PopupRenderer {
     private partialEmitted;
     constructor(options?: ReactNativeRendererOptions);
     init(): void;
-    show(surveyId: string, productId: string, actions: PopupActions | undefined, emit: EmitFn, onClose: () => void, env?: string, userId?: string, style?: PopupStyle, sessionId?: string, miniService?: string, analyticsFeedbackSessionId?: string): void;
+    show(surveyId: string, productId: string, actions: PopupActions | undefined, emit: EmitFn, onClose: () => void, env?: string, userId?: string, style?: PopupStyle, sessionId?: string, miniService?: string, analyticsFeedbackSessionId?: string, renderChrome?: boolean, options?: PopupRenderOptions): void;
     hide(): void;
     /**
      * El host la conecta al `onMessage` del WebView. Traduce los mensajes del survey a