@sprig-technologies/sprig-bundled 1.0.0-beta.2 → 1.0.2

package/dist/index.d.ts

@@ -1884,6 +1884,7 @@ declare enum DismissReason {
     Override = "override"
 }
 declare enum SprigEvent {
+    ReplayCapture = "replay.capture",
     SDKReady = "sdk.ready",
     SurveyAppeared = "survey.appeared",
     SurveyClosed = "survey.closed",
@@ -1913,6 +1914,7 @@ declare const EVENTS: {
     SURVEY_WILL_CLOSE: SprigEvent;
     SURVEY_WILL_PRESENT: SprigEvent;
     QUESTION_ANSWERED: SprigEvent;
+    REPLAY_CAPTURE: SprigEvent;
     CLOSE_SURVEY_ON_OVERLAY_CLICK: SprigEvent;
     VISITOR_ID_UPDATED: SprigEvent;
     DATA: {
@@ -2327,6 +2329,14 @@ interface RecordedTaskResponseType {
     value: RecordedTaskResponseValueType;
 }
 
+interface MobileReplayConfig {
+    maxMobileReplayDurationSeconds?: number;
+    mobileReplaySettings?: {
+        hideAllFormContents: boolean;
+        hidePasswordsOnly: boolean;
+        hideAllImages: boolean;
+    };
+}
 type SprigEventMap = {
     [InternalEventName.CurrentQuestion]: [
         {
@@ -2343,7 +2353,7 @@ type SprigEventMap = {
         }
     ];
     [SprigEvent.CloseSurveyOnOverlayClick]: [];
-    [SprigEvent.SDKReady]: [];
+    [SprigEvent.SDKReady]: [MobileReplayConfig];
     [SprigEvent.SurveyAppeared]: [];
     [SprigEvent.SurveyDimensions]: [
         {
@@ -2395,6 +2405,17 @@ type SprigEventMap = {
             value: unknown;
         }
     ];
+    [SprigEvent.ReplayCapture]: [
+        {
+            responseGroupUid: string;
+            hasQuestions: boolean;
+            uploadId: string;
+            seconds: number;
+            replayType: ReplayDurationType;
+            generateVideoUploadUrlPayload: object;
+            surveyId: number;
+        }
+    ];
     [SprigRecordingEvent.AvPermission]: [
         {
             [SprigRecordingEventData.StreamReadyCallback]: (avStream: MediaStream | null, captureStream?: MediaStream | null) => void;
@@ -2490,7 +2511,7 @@ interface Answer {
     questionId: number;
     value: unknown;
 }
-interface Config {
+interface Config extends MobileReplayConfig {
     allResponses: unknown[];
     answers?: Answer[];
     apiURL: string;
@@ -2541,6 +2562,8 @@ interface Config {
         [HttpHeader.PreviewMode]?: string;
         /** @example "2.18.0" */
         "x-ul-sdk-version": string;
+        /** For web-bundled sdk */
+        "x-ul-bundled-sdk-version"?: string;
         [HttpHeader.UserID]?: string;
         [HttpHeader.VisitorID]?: UUID;
     };
@@ -2593,6 +2616,11 @@ interface Config {
     };
 }
 
+declare enum ReplayDurationType {
+    After = "after",
+    Before = "before",
+    BeforeAndAfter = "beforeAndAfter"
+}
 declare enum ReplayEventType {
     Click = "Sprig_Click",
     Event = "Sprig_TrackEvent",
@@ -2697,6 +2725,7 @@ declare namespace sprigConfig {
       surveyId?: number;
       updatedAt?: string;
       visitorId?: string | null;
+      isReplay?: boolean;
     }) => Promise<string | null>;
     _previewSurvey: (surveyTemplateId: UUID) => void;
     _reviewSurvey: (surveyId: number) => void;
@@ -2788,7 +2817,6 @@ declare namespace sprigConfig {
       frameId: string;
       loaded: boolean;
       locale?: string;
-      localStorageAvailable: boolean;
       maxHeight?: number | string;
       maxInflightReplayRequests?: number;
       mobileHeadersJSON?: string;
@@ -2872,7 +2900,10 @@ declare class SprigAPI {
         SURVEY_WILL_CLOSE: SprigEvent;
         SURVEY_WILL_PRESENT: SprigEvent;
         QUESTION_ANSWERED: SprigEvent;
-        CLOSE_SURVEY_ON_OVERLAY_CLICK: SprigEvent;
+        REPLAY_CAPTURE: SprigEvent;
+        CLOSE_SURVEY_ON_OVERLAY_CLICK: SprigEvent; /**
+         * Attach a user id to the visitor
+         */
         VISITOR_ID_UPDATED: SprigEvent;
         DATA: {
             DISMISS_REASONS: {