@magicfeedback/popup-sdk 1.8.5 → 1.10.0

package/dist/react-native.d.mts

@@ -122,6 +122,19 @@ interface DeepdotsLogger {
     error?: (...args: unknown[]) => void;
     info?: (...args: unknown[]) => void;
 }
+/**
+ * A session of the analytics channel as the Deepdots API sees it. Every session becomes ONE
+ * feedback, and `sessionId` is what the API stores as `sdkSessionId` on it: the value to look
+ * that feedback up with (`GET /feedbacks?filter={"where":{"sdkSessionId":"<sessionId>"}}`).
+ * A session that closes again keeps that one feedback: the API updates it.
+ *  - `open`: the API acknowledged the session's first batch; its events keep accumulating.
+ *  - `closed`: the API acknowledged the session's closing batch (`completed: true`); the
+ *    feedback is created from it within seconds.
+ */
+interface FeedbackSession {
+    sessionId: string;
+    status: 'open' | 'closed';
+}
 interface DeepdotsInitParams {
     /** API key for authentication */
     apiKey?: string;
@@ -157,6 +170,17 @@ interface DeepdotsInitParams {
      * logged when `debug` is true.
      */
     analytics?: AnalyticsKeys;
+    /**
+     * Called when the analytics channel opens or closes a session (needs `analytics`), with the
+     * id the Deepdots API stores as `sdkSessionId` on the feedback the session becomes: send it
+     * to your backend to attach data to that feedback later. A session whose only batch is the
+     * closing one reports just `closed`. `closed` does not come when the page unloads before the
+     * closing request returns, for a session dropped after 30 min hidden, nor when the closing
+     * request fails (the API closes those itself, later): their id already came with `open`. Key
+     * by `sessionId`, not by order: the next session's `open` can arrive before the previous
+     * one's `closed`. Same value as `getFeedbackSessionId()` while the session is open.
+     */
+    onFeedbackSession?: (session: FeedbackSession) => void;
     /**
      * IP geolocation (country/city) added to analytics. Default `true`. The lookup calls
      * third-party services (ipapi.co, then ipwho.is, then ipinfo.io as fallbacks, 3 s timeout
@@ -392,6 +416,8 @@ declare class DeepdotsPopups {
     private analytics;
     /** feedbackSessionId cacheado del canal de analytics (devuelto por POST /sdk/feedback). */
     private analyticsFeedbackSessionId;
+    /** `init({ onFeedbackSession })`: avisa al host al abrir y cerrar cada registro. */
+    private onFeedbackSession;
     /** Timer del flush periódico de analytics (cada ANALYTICS_FLUSH_INTERVAL_MS). */
     private analyticsFlushTimer;
     /** Crash & error reporting (#14–17). Null hasta init(). */
@@ -435,6 +461,15 @@ declare class DeepdotsPopups {
     getUserId(): string | null;
     /** Session id de navegación actual. Null si tracking off. */
     getSessionId(): string | null;
+    /**
+     * Id del registro de analytics abierto: el `sessionId` que devolvió `POST /sdk/feedback`,
+     * que la API guarda como `sdkSessionId` en el Feedback en que se convierte la sesión. No es
+     * `getSessionId()`. Null hasta que el backend acepta el primer lote y de nuevo al cerrar la
+     * sesión: para saber también qué registro se cerró, usa `init({ onFeedbackSession })`.
+     */
+    getFeedbackSessionId(): string | null;
+    /** Avisa al host del registro abierto o cerrado; un fallo del host no corta el envío. */
+    private notifyFeedbackSession;
     /** Activa/desactiva el tracking (identidad + sesión + analytics). Kill-switch del contrato §7bis. */
     setTrackingEnabled(enabled: boolean): void;
     /** Registra un evento de analítica (modelo GA: nombre + params). No-op si tracking off. */

package/dist/react-native.d.ts

@@ -122,6 +122,19 @@ interface DeepdotsLogger {
     error?: (...args: unknown[]) => void;
     info?: (...args: unknown[]) => void;
 }
+/**
+ * A session of the analytics channel as the Deepdots API sees it. Every session becomes ONE
+ * feedback, and `sessionId` is what the API stores as `sdkSessionId` on it: the value to look
+ * that feedback up with (`GET /feedbacks?filter={"where":{"sdkSessionId":"<sessionId>"}}`).
+ * A session that closes again keeps that one feedback: the API updates it.
+ *  - `open`: the API acknowledged the session's first batch; its events keep accumulating.
+ *  - `closed`: the API acknowledged the session's closing batch (`completed: true`); the
+ *    feedback is created from it within seconds.
+ */
+interface FeedbackSession {
+    sessionId: string;
+    status: 'open' | 'closed';
+}
 interface DeepdotsInitParams {
     /** API key for authentication */
     apiKey?: string;
@@ -157,6 +170,17 @@ interface DeepdotsInitParams {
      * logged when `debug` is true.
      */
     analytics?: AnalyticsKeys;
+    /**
+     * Called when the analytics channel opens or closes a session (needs `analytics`), with the
+     * id the Deepdots API stores as `sdkSessionId` on the feedback the session becomes: send it
+     * to your backend to attach data to that feedback later. A session whose only batch is the
+     * closing one reports just `closed`. `closed` does not come when the page unloads before the
+     * closing request returns, for a session dropped after 30 min hidden, nor when the closing
+     * request fails (the API closes those itself, later): their id already came with `open`. Key
+     * by `sessionId`, not by order: the next session's `open` can arrive before the previous
+     * one's `closed`. Same value as `getFeedbackSessionId()` while the session is open.
+     */
+    onFeedbackSession?: (session: FeedbackSession) => void;
     /**
      * IP geolocation (country/city) added to analytics. Default `true`. The lookup calls
      * third-party services (ipapi.co, then ipwho.is, then ipinfo.io as fallbacks, 3 s timeout
@@ -392,6 +416,8 @@ declare class DeepdotsPopups {
     private analytics;
     /** feedbackSessionId cacheado del canal de analytics (devuelto por POST /sdk/feedback). */
     private analyticsFeedbackSessionId;
+    /** `init({ onFeedbackSession })`: avisa al host al abrir y cerrar cada registro. */
+    private onFeedbackSession;
     /** Timer del flush periódico de analytics (cada ANALYTICS_FLUSH_INTERVAL_MS). */
     private analyticsFlushTimer;
     /** Crash & error reporting (#14–17). Null hasta init(). */
@@ -435,6 +461,15 @@ declare class DeepdotsPopups {
     getUserId(): string | null;
     /** Session id de navegación actual. Null si tracking off. */
     getSessionId(): string | null;
+    /**
+     * Id del registro de analytics abierto: el `sessionId` que devolvió `POST /sdk/feedback`,
+     * que la API guarda como `sdkSessionId` en el Feedback en que se convierte la sesión. No es
+     * `getSessionId()`. Null hasta que el backend acepta el primer lote y de nuevo al cerrar la
+     * sesión: para saber también qué registro se cerró, usa `init({ onFeedbackSession })`.
+     */
+    getFeedbackSessionId(): string | null;
+    /** Avisa al host del registro abierto o cerrado; un fallo del host no corta el envío. */
+    private notifyFeedbackSession;
     /** Activa/desactiva el tracking (identidad + sesión + analytics). Kill-switch del contrato §7bis. */
     setTrackingEnabled(enabled: boolean): void;
     /** Registra un evento de analítica (modelo GA: nombre + params). No-op si tracking off. */