@magicfeedback/popup-sdk 1.8.4 → 1.9.0

package/dist/index.d.mts

@@ -192,6 +192,12 @@ interface FeedbackSinkOptions {
     onSessionId?: (id: string) => void;
     /** Callback invocado al cerrar la sesión (`completed:true`): el sessionId cacheado se olvida. */
     onSessionReset?: () => void;
+    /**
+     * Callback invocado cuando el backend acepta el lote de cierre, con el sessionId del
+     * registro cerrado: el que llevaba el lote o, en una sesión de un solo lote, el que
+     * devuelve la respuesta. Ese registro se convierte en Feedback en segundos.
+     */
+    onSessionClosed?: (id: string) => void;
 }
 /**
  * Sink real: transforma el envelope y hace `POST {baseUrl}/sdk/feedback`.
@@ -226,6 +232,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;
@@ -261,6 +280,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
@@ -698,6 +728,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(). */
@@ -741,6 +773,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. */
@@ -1265,4 +1306,4 @@ declare function collectRnDevice(d: DeviceInfoLike): DeviceInfo;
  */
 declare function setupReactNative(sdk: DeepdotsPopups, config: DeepdotsInitParams, deps?: ReactNativeSetupDeps): () => void;
 
-export { type AnalyticsFeedbackBody, type AnalyticsKeys, type AppStateLike, BrowserPopupRenderer, type BuildBodyOptions, type ContactAttributeValue, type ContactAttributes, type ContactBody, ContactManager, type CrashRecord, CrashReporter, type CrashSeverity, type DeepdotsConfig, type DeepdotsEvent, type DeepdotsEventType, type DeepdotsInitParams, type DeepdotsLogger, DeepdotsPopups, type DeviceInfo, type DeviceInfoLike, type DeviceSnapshot, type EventListener, type FeedbackKV, InMemoryStorage, type KeyValueStorage, LABELS, MAX_TRACKED_MESSAGES, MESSAGE_CHANNELS, type MessageChannel, MessageGuard, type MessageGuardVerdict, type MessageRejectionReason, type MessageStage, type MmkvLike, NATIVE_READY_GRACE_MS, NoopPopupRenderer, POPUP_TRIGGER_CONDITION_STATUSES, type PopupDefinition, type PopupLabels, type PopupLocale, type PopupRenderer, type PopupTrigger, type PopupTriggerCondition, type PopupTriggerConditionStatus, REVEAL_TIMEOUT_MS, RTL_LOCALES, type ReactNativeErrorUtils, ReactNativePopupRenderer, type ReactNativeRendererOptions, type ReactNativeSetupDeps, type ReactNativeSurveyPayload, type ReportErrorOptions, type ResolvedActionLabels, SUPPORTED_LANGUAGES, type SessionEndReason, type TrackMessageOptions, type TriggerConfig, buildAnalyticsFeedbackBody, buildMessageParams, buildSurveyHtml, collectRnDevice, crashRecordToParams, createDefaultRenderer, createFeedbackSink, directionFor, getLabels, isRtlLanguage, mmkvStorage, resolveActionLabels, resolveLocale, setupReactNative };
+export { type AnalyticsFeedbackBody, type AnalyticsKeys, type AppStateLike, BrowserPopupRenderer, type BuildBodyOptions, type ContactAttributeValue, type ContactAttributes, type ContactBody, ContactManager, type CrashRecord, CrashReporter, type CrashSeverity, type DeepdotsConfig, type DeepdotsEvent, type DeepdotsEventType, type DeepdotsInitParams, type DeepdotsLogger, DeepdotsPopups, type DeviceInfo, type DeviceInfoLike, type DeviceSnapshot, type EventListener, type FeedbackKV, type FeedbackSession, InMemoryStorage, type KeyValueStorage, LABELS, MAX_TRACKED_MESSAGES, MESSAGE_CHANNELS, type MessageChannel, MessageGuard, type MessageGuardVerdict, type MessageRejectionReason, type MessageStage, type MmkvLike, NATIVE_READY_GRACE_MS, NoopPopupRenderer, POPUP_TRIGGER_CONDITION_STATUSES, type PopupDefinition, type PopupLabels, type PopupLocale, type PopupRenderer, type PopupTrigger, type PopupTriggerCondition, type PopupTriggerConditionStatus, REVEAL_TIMEOUT_MS, RTL_LOCALES, type ReactNativeErrorUtils, ReactNativePopupRenderer, type ReactNativeRendererOptions, type ReactNativeSetupDeps, type ReactNativeSurveyPayload, type ReportErrorOptions, type ResolvedActionLabels, SUPPORTED_LANGUAGES, type SessionEndReason, type TrackMessageOptions, type TriggerConfig, buildAnalyticsFeedbackBody, buildMessageParams, buildSurveyHtml, collectRnDevice, crashRecordToParams, createDefaultRenderer, createFeedbackSink, directionFor, getLabels, isRtlLanguage, mmkvStorage, resolveActionLabels, resolveLocale, setupReactNative };

package/dist/index.d.ts

@@ -192,6 +192,12 @@ interface FeedbackSinkOptions {
     onSessionId?: (id: string) => void;
     /** Callback invocado al cerrar la sesión (`completed:true`): el sessionId cacheado se olvida. */
     onSessionReset?: () => void;
+    /**
+     * Callback invocado cuando el backend acepta el lote de cierre, con el sessionId del
+     * registro cerrado: el que llevaba el lote o, en una sesión de un solo lote, el que
+     * devuelve la respuesta. Ese registro se convierte en Feedback en segundos.
+     */
+    onSessionClosed?: (id: string) => void;
 }
 /**
  * Sink real: transforma el envelope y hace `POST {baseUrl}/sdk/feedback`.
@@ -226,6 +232,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;
@@ -261,6 +280,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
@@ -698,6 +728,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(). */
@@ -741,6 +773,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. */
@@ -1265,4 +1306,4 @@ declare function collectRnDevice(d: DeviceInfoLike): DeviceInfo;
  */
 declare function setupReactNative(sdk: DeepdotsPopups, config: DeepdotsInitParams, deps?: ReactNativeSetupDeps): () => void;
 
-export { type AnalyticsFeedbackBody, type AnalyticsKeys, type AppStateLike, BrowserPopupRenderer, type BuildBodyOptions, type ContactAttributeValue, type ContactAttributes, type ContactBody, ContactManager, type CrashRecord, CrashReporter, type CrashSeverity, type DeepdotsConfig, type DeepdotsEvent, type DeepdotsEventType, type DeepdotsInitParams, type DeepdotsLogger, DeepdotsPopups, type DeviceInfo, type DeviceInfoLike, type DeviceSnapshot, type EventListener, type FeedbackKV, InMemoryStorage, type KeyValueStorage, LABELS, MAX_TRACKED_MESSAGES, MESSAGE_CHANNELS, type MessageChannel, MessageGuard, type MessageGuardVerdict, type MessageRejectionReason, type MessageStage, type MmkvLike, NATIVE_READY_GRACE_MS, NoopPopupRenderer, POPUP_TRIGGER_CONDITION_STATUSES, type PopupDefinition, type PopupLabels, type PopupLocale, type PopupRenderer, type PopupTrigger, type PopupTriggerCondition, type PopupTriggerConditionStatus, REVEAL_TIMEOUT_MS, RTL_LOCALES, type ReactNativeErrorUtils, ReactNativePopupRenderer, type ReactNativeRendererOptions, type ReactNativeSetupDeps, type ReactNativeSurveyPayload, type ReportErrorOptions, type ResolvedActionLabels, SUPPORTED_LANGUAGES, type SessionEndReason, type TrackMessageOptions, type TriggerConfig, buildAnalyticsFeedbackBody, buildMessageParams, buildSurveyHtml, collectRnDevice, crashRecordToParams, createDefaultRenderer, createFeedbackSink, directionFor, getLabels, isRtlLanguage, mmkvStorage, resolveActionLabels, resolveLocale, setupReactNative };
+export { type AnalyticsFeedbackBody, type AnalyticsKeys, type AppStateLike, BrowserPopupRenderer, type BuildBodyOptions, type ContactAttributeValue, type ContactAttributes, type ContactBody, ContactManager, type CrashRecord, CrashReporter, type CrashSeverity, type DeepdotsConfig, type DeepdotsEvent, type DeepdotsEventType, type DeepdotsInitParams, type DeepdotsLogger, DeepdotsPopups, type DeviceInfo, type DeviceInfoLike, type DeviceSnapshot, type EventListener, type FeedbackKV, type FeedbackSession, InMemoryStorage, type KeyValueStorage, LABELS, MAX_TRACKED_MESSAGES, MESSAGE_CHANNELS, type MessageChannel, MessageGuard, type MessageGuardVerdict, type MessageRejectionReason, type MessageStage, type MmkvLike, NATIVE_READY_GRACE_MS, NoopPopupRenderer, POPUP_TRIGGER_CONDITION_STATUSES, type PopupDefinition, type PopupLabels, type PopupLocale, type PopupRenderer, type PopupTrigger, type PopupTriggerCondition, type PopupTriggerConditionStatus, REVEAL_TIMEOUT_MS, RTL_LOCALES, type ReactNativeErrorUtils, ReactNativePopupRenderer, type ReactNativeRendererOptions, type ReactNativeSetupDeps, type ReactNativeSurveyPayload, type ReportErrorOptions, type ResolvedActionLabels, SUPPORTED_LANGUAGES, type SessionEndReason, type TrackMessageOptions, type TriggerConfig, buildAnalyticsFeedbackBody, buildMessageParams, buildSurveyHtml, collectRnDevice, crashRecordToParams, createDefaultRenderer, createFeedbackSink, directionFor, getLabels, isRtlLanguage, mmkvStorage, resolveActionLabels, resolveLocale, setupReactNative };