@sprig-technologies/sprig-browser 2.24.2 → 2.24.4

package/dist/index.d.ts

@@ -263,7 +263,8 @@ declare enum SprigEvent {
     SurveyWillClose = "survey.willClose",
     SurveyWillPresent = "survey.will.present",
     CloseSurveyOnOverlayClick = "close.survey.overlayClick",
-    VisitorIDUpdated = "visitor.id.updated"
+    VisitorIDUpdated = "visitor.id.updated",
+    QuestionAnswered = "question.answered"
 }
 declare enum SprigEventData {
     SurveyId = "survey.id"
@@ -279,6 +280,7 @@ declare const EVENTS: {
     SURVEY_LIFE_CYCLE: SprigEvent;
     SURVEY_WILL_CLOSE: SprigEvent;
     SURVEY_WILL_PRESENT: SprigEvent;
+    QUESTION_ANSWERED: SprigEvent;
     CLOSE_SURVEY_ON_OVERLAY_CLICK: SprigEvent;
     VISITOR_ID_UPDATED: SprigEvent;
     DATA: {
@@ -726,6 +728,13 @@ declare type SprigEventMap = {
     [SprigEvent.VisitorIDUpdated]: [{
         visitorId: string | null;
     }];
+    [SprigEvent.QuestionAnswered]: [
+        {
+            answeredAt?: number;
+            questionIndex?: number;
+            value: unknown;
+        }
+    ];
     [SprigRecordingEvent.AvPermission]: [
         {
             [SprigRecordingEventData.StreamReadyCallback]: (avStream: MediaStream | null, captureStream?: MediaStream | null) => void;
@@ -1086,6 +1095,7 @@ declare namespace sprigConfig {
       height: number | string
     ) => void;
     setEmail: (email: string) => IdentifyResult;
+    setPreviewKey: (previewKey: string) => void;
     setUserId: (userId: string) => IdentifyResult;
     setVisitorEmail: (email: string) => IdentifyResult;
     setVisitorToken: () => void;
@@ -1096,6 +1106,11 @@ declare namespace sprigConfig {
       metadata?: SprigMetadata,
       showSurveyCallback?: (surveyId?: number) => Promise<boolean>
     ) => IdentifyResult;
+    trackPageView: (
+      url: string,
+      properties?: SprigProperties,
+      showSurveyCallback?: (surveyId?: number) => Promise<boolean>
+    ) => void;
     unmute: () => void;
   }
 
@@ -1189,7 +1204,10 @@ declare class SprigAPI {
         SURVEY_LIFE_CYCLE: SprigEvent;
         SURVEY_WILL_CLOSE: SprigEvent;
         SURVEY_WILL_PRESENT: SprigEvent;
-        CLOSE_SURVEY_ON_OVERLAY_CLICK: SprigEvent;
+        QUESTION_ANSWERED: SprigEvent;
+        CLOSE_SURVEY_ON_OVERLAY_CLICK: SprigEvent; /**
+         * Attach an email address to visitor
+         */
         VISITOR_ID_UPDATED: SprigEvent;
         DATA: {
             DISMISS_REASONS: {
@@ -1276,6 +1294,10 @@ declare class SprigAPI {
         metadata?: SprigMetadata;
         userId?: string;
     }): void;
+    /**
+     * Tracks a page view with the provided URL and additional event properties.
+     */
+    trackPageView(url: string, props?: SprigProperties, showSurveyCallback?: (surveyId?: number) => Promise<boolean>): void;
     /**
      * Apply a css string representing the customized styles
      */