@sprig-technologies/sprig-browser 2.24.11 → 2.25.0

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",
@@ -1892,6 +1893,7 @@ declare enum SprigEvent {
     SurveyHeight = "survey.height",
     SurveyPresented = "survey.presented",
     SurveyLifeCycle = "survey.lifeCycle",
+    SurveyWidth = "survey.width",
     SurveyWillClose = "survey.willClose",
     SurveyWillPresent = "survey.will.present",
     CloseSurveyOnOverlayClick = "close.survey.overlayClick",
@@ -1913,6 +1915,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: {
@@ -2024,6 +2027,7 @@ declare enum BooleanOperator {
 declare const enum CardType {
     ConsentLegal = "consentlegal",
     Likert = "likert",
+    Matrix = "matrix",
     MultipleChoice = "multiplechoice",
     MultipleSelect = "multipleselect",
     NPS = "nps",
@@ -2043,20 +2047,21 @@ interface BaseCard {
 }
 declare const enum Comparator {
     Answered = "answered",
+    Contains = "contains",
+    DoesNotContain = "notcontains",
+    DoesNotInclude = "list_dni",
     Equal = "eq",
-    NotEqual = "neq",
-    Skipped = "skipped",
-    LessThan = "lt",
-    LessThanOrEqual = "lte",
     GivenUp = "given_up",
     GreaterThan = "gt",
     GreaterThanOrEqual = "gte",
+    LessThan = "lt",
+    LessThanOrEqual = "lte",
     ListAll = "list_all",
     ListAtLeastOne = "list_alo",
     ListExact = "list_exact",
-    DoesNotInclude = "list_dni",
-    Contains = "contains",
-    DoesNotContain = "notcontains"
+    NotEqual = "neq",
+    Partial = "partial",
+    Skipped = "skipped"
 }
 type DefaultComparator = Comparator.Answered | Comparator.Skipped;
 type RoutingOption<C extends Comparator = DefaultComparator> = OldRoutingOption<C> | GroupRoutingOption;
@@ -2279,6 +2284,25 @@ interface MultipleChoiceSingleSelectCard extends MultiChoiceCard<Comparator.Equa
 interface MultipleChoiceMultiSelectCard extends MultiChoiceCard<Comparator.ListAll | Comparator.ListAtLeastOne | Comparator.ListExact | Comparator.DoesNotInclude> {
     type: CardType.MultipleSelect;
 }
+interface MatrixCard extends BaseCard {
+    props: {
+        options: MultipleChoiceOption[];
+        message: string;
+        routingOptions: RoutingOptions<Comparator.Skipped | Comparator.Partial | Comparator.Answered>;
+        properties: {
+            buttonText?: string;
+            captionText: string;
+            conceptUrl: ConceptUrl;
+            matrixColumn: {
+                label: string;
+                value: string;
+            }[];
+            randomize: "none" | "all";
+            required: boolean;
+        };
+    };
+    type: CardType.Matrix;
+}
 interface NPSCard extends BaseCard {
     props: {
         labels: {
@@ -2319,7 +2343,7 @@ interface VideoVoiceCard extends BaseCard {
     };
     type: CardType.VideoVoice;
 }
-type Card = TextUrlPromptCard | ConsentLegalCard | RecordedTaskCard | LikertCard | OpenTextCard | MultipleChoiceSingleSelectCard | MultipleChoiceMultiSelectCard | NPSCard | VideoVoiceCard;
+type Card = TextUrlPromptCard | ConsentLegalCard | RecordedTaskCard | LikertCard | OpenTextCard | MatrixCard | MultipleChoiceSingleSelectCard | MultipleChoiceMultiSelectCard | NPSCard | VideoVoiceCard;
 
 interface RecordedTaskResponseType {
     questionId: number;
@@ -2327,6 +2351,14 @@ interface RecordedTaskResponseType {
     value: RecordedTaskResponseValueType;
 }
 
+interface MobileReplayConfig {
+    maxMobileReplayDurationSeconds?: number;
+    mobileReplaySettings?: {
+        hideAllFormContents: boolean;
+        hidePasswordsOnly: boolean;
+        hideAllImages: boolean;
+    };
+}
 type SprigEventMap = {
     [InternalEventName.CurrentQuestion]: [
         {
@@ -2343,8 +2375,13 @@ type SprigEventMap = {
         }
     ];
     [SprigEvent.CloseSurveyOnOverlayClick]: [];
-    [SprigEvent.SDKReady]: [];
-    [SprigEvent.SurveyAppeared]: [];
+    [SprigEvent.SDKReady]: [MobileReplayConfig];
+    [SprigEvent.SurveyAppeared]: [
+        {
+            name: string;
+            [SprigEventData.SurveyId]: number;
+        }
+    ];
     [SprigEvent.SurveyDimensions]: [
         {
             contentFrameHeight: number;
@@ -2365,12 +2402,19 @@ type SprigEventMap = {
             contentFrameHeight: number;
         }
     ];
+    [SprigEvent.SurveyWidth]: [
+        {
+            name: string;
+            contentFrameWidth: number;
+        }
+    ];
     [SprigEvent.SurveyLifeCycle]: [{
         state: string;
     }];
     [SprigEvent.SurveyPresented]: [
         {
             name: string;
+            [SprigEventData.SurveyId]: number;
         }
     ];
     [SprigEvent.SurveyWillClose]: [
@@ -2382,7 +2426,7 @@ type SprigEventMap = {
     [SprigEvent.SurveyWillPresent]: [
         {
             name: string;
-            "survey.id": number;
+            [SprigEventData.SurveyId]: number;
         }
     ];
     [SprigEvent.VisitorIDUpdated]: [{
@@ -2395,6 +2439,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 +2545,7 @@ interface Answer {
     questionId: number;
     value: unknown;
 }
-interface Config {
+interface Config extends MobileReplayConfig {
     allResponses: unknown[];
     answers?: Answer[];
     apiURL: string;
@@ -2526,6 +2581,7 @@ interface Config {
     frame: HTMLIFrameElement & {
         eventEmitter?: SprigEventEmitter;
         setHeight?: (height: number) => void;
+        setWidth?: (width: number) => void;
     };
     framePosition: FramePosition;
     headers: {
@@ -2541,6 +2597,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 +2651,11 @@ interface Config {
     };
 }
 
+declare enum ReplayDurationType {
+    After = "after",
+    Before = "before",
+    BeforeAndAfter = "beforeAndAfter"
+}
 declare enum ReplayEventType {
     Click = "Sprig_Click",
     Event = "Sprig_TrackEvent",
@@ -2697,6 +2760,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 +2852,6 @@ declare namespace sprigConfig {
       frameId: string;
       loaded: boolean;
       locale?: string;
-      localStorageAvailable: boolean;
       maxHeight?: number | string;
       maxInflightReplayRequests?: number;
       mobileHeadersJSON?: string;
@@ -2872,6 +2935,7 @@ declare class SprigAPI {
         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: {