@sprig-technologies/sprig-browser 2.26.6 → 2.28.0

package/dist/index.d.ts

@@ -1821,41 +1821,8 @@ declare class Emitter<Events extends EventMap> {
     rawListeners<EventName extends keyof Events>(eventName: EventName): Array<Listener<Events[EventName]>>;
 }
 
-declare const enum MediaType {
-    Video = "video",
-    Audio = "audio",
-    Screen = "screen"
-}
-declare const enum SprigRecordingEvent {
-    PermissionStatus = "permission.status",
-    AvPermission = "av.permission",
-    ScreenPermission = "screen.permission",
-    BeginRecording = "begin.recording",
-    StartTask = "start.task",
-    FinishTask = "finish.task"
-}
-declare const enum TaskStatus {
-    Abandoned = "abandoned",
-    GivenUp = "given.up",
-    Completed = "completed"
-}
-declare const enum SprigRecordingEventData {
-    ScreenPermissionRequested = "screen.permission.requested",
-    PermissionDescriptors = "permission.descriptors",
-    PermissionStatusCallback = "permission.status.callback",
-    StreamReadyCallback = "stream.ready.callback",
-    StreamCanceledCallback = "stream.canceled.callback",
-    TaskCompleteCallback = "task.complete.callback",
-    TaskResponse = "task.response",
-    TaskStatus = "task.status",
-    RecordingMediaTypes = "recording.media.types",
-    StartRecordingCallback = "start.recording.callback",
-    PassthroughData = "passthrough.data",
-    CurrentIndex = "current.index",
-    UploadCallback = "upload.callback",
-    ProgressCallback = "progress.callback",
-    BeginCallback = "begin.callback"
-}
+type MediaType = "video" | "audio" | "screen";
+type TaskStatus = "abandoned" | "given.up" | "completed";
 interface PassthroughData {
     questionId: number;
     surveyId: number;
@@ -1868,51 +1835,23 @@ interface RecordedTaskResponseValueType {
     taskDurationMillisecond?: number;
     taskStatus: TaskStatus;
 }
-declare enum BooleanOperator {
-    And = 1,
-    Or = 2
-}
+declare const BOOLEAN_OPERATOR: {
+    readonly And: 1;
+    readonly Or: 2;
+};
+type BooleanOperator = (typeof BOOLEAN_OPERATOR)[keyof typeof BOOLEAN_OPERATOR];
 
-declare const enum CardType {
-    ConsentLegal = "consentlegal",
-    Likert = "likert",
-    Matrix = "matrix",
-    MultipleChoice = "multiplechoice",
-    MultipleSelect = "multipleselect",
-    NPS = "nps",
-    Open = "open",
-    RecordedTask = "recordedtask",
-    TextUrlPrompt = "texturlprompt",
-    Thanks = "thanks",
-    Uploading = "uploading",
-    VideoVoice = "videovoice"
-}
+type CardType = "consentlegal" | "likert" | "matrix" | "multiplechoice" | "multipleselect" | "nps" | "open" | "recordedtask" | "texturlprompt" | "thanks" | "uploading" | "videovoice";
 type ConceptUrl = string | null;
 interface BaseCard {
     name: number;
     surveyId: number;
     updatedAt: string;
     value?: unknown;
+    type: CardType;
 }
-declare const enum Comparator {
-    Answered = "answered",
-    Contains = "contains",
-    DoesNotContain = "notcontains",
-    DoesNotInclude = "list_dni",
-    Equal = "eq",
-    GivenUp = "given_up",
-    GreaterThan = "gt",
-    GreaterThanOrEqual = "gte",
-    LessThan = "lt",
-    LessThanOrEqual = "lte",
-    ListAll = "list_all",
-    ListAtLeastOne = "list_alo",
-    ListExact = "list_exact",
-    NotEqual = "neq",
-    Partial = "partial",
-    Skipped = "skipped"
-}
-type DefaultComparator = Comparator.Answered | Comparator.Skipped;
+type Comparator = "answered" | "contains" | "notcontains" | "list_dni" | "eq" | "given_up" | "gt" | "gte" | "lt" | "lte" | "list_all" | "list_alo" | "list_exact" | "neq" | "partial" | "skipped";
+type DefaultComparator = Extract<Comparator, "answered" | "skipped">;
 type RoutingOption<C extends Comparator = DefaultComparator> = OldRoutingOption<C> | GroupRoutingOption;
 type OldRoutingOption<C extends Comparator = DefaultComparator> = {
     comparator: C;
@@ -1934,10 +1873,7 @@ type RoutingGroupOption = {
 type RoutingOptions<C extends Comparator = DefaultComparator> = RoutingOption<C | DefaultComparator>[] | null;
 /** @example <p>Body</p> */
 type RichTextBody = string;
-declare const enum PromptActionType {
-    Continue = "CONTINUE",
-    External = "EXTERNAL"
-}
+type PromptActionType = "CONTINUE" | "EXTERNAL";
 interface TextUrlPromptCard extends BaseCard {
     props: {
         message: string;
@@ -1954,13 +1890,9 @@ interface TextUrlPromptCard extends BaseCard {
         };
         routingOptions: RoutingOptions;
     };
-    type: CardType.TextUrlPrompt;
-}
-declare const enum AvPermission {
-    Camera = "camera",
-    Microphone = "microphone",
-    Screen = "screen"
+    type: "texturlprompt";
 }
+type AvPermission = "camera" | "microphone" | "screen";
 interface ConsentLegalCard extends BaseCard {
     props: {
         message: string;
@@ -1983,18 +1915,14 @@ interface ConsentLegalCard extends BaseCard {
         };
         routingOptions: RoutingOptions;
     };
-    type: CardType.ConsentLegal;
+    type: "consentlegal";
 }
 interface BaseTaskPage {
     buttonText: string;
     headline: string;
+    type: RecordedTaskPageType;
 }
-declare const enum RecordedTaskPageType {
-    AvPermission = "av_permission",
-    ScreenPermission = "screen_permission",
-    StartTask = "start_task",
-    CompleteTask = "complete_task"
-}
+type RecordedTaskPageType = "av_permission" | "screen_permission" | "start_task" | "complete_task";
 interface PermissionTaskPage extends BaseTaskPage {
     captionText: string;
     headline: string;
@@ -2006,7 +1934,7 @@ interface PermissionTaskPage extends BaseTaskPage {
     skipButtonText?: string;
     svg: string;
     tryAgainButtonText: string;
-    type: RecordedTaskPageType.AvPermission;
+    type: "av_permission";
 }
 interface ScreenTaskPage extends BaseTaskPage {
     captionText: string;
@@ -2014,19 +1942,19 @@ interface ScreenTaskPage extends BaseTaskPage {
     permissionDeniedHeadline: string;
     selectTabText: string;
     skipButtonText: string;
-    type: RecordedTaskPageType.ScreenPermission;
+    type: "screen_permission";
 }
 interface StartTaskPage extends BaseTaskPage {
     captionText?: string;
     skipButtonText: string;
     taskDetail: string;
-    type: RecordedTaskPageType.StartTask;
+    type: "start_task";
 }
 interface CompleteTaskPage extends BaseTaskPage {
     captionText?: string;
     skipButtonText: string;
     taskDetail: string;
-    type: RecordedTaskPageType.CompleteTask;
+    type: "complete_task";
 }
 type RecordedTaskPage = PermissionTaskPage | ScreenTaskPage | StartTaskPage | CompleteTaskPage;
 interface RecordedTaskCardProperties {
@@ -2042,9 +1970,9 @@ interface RecordedTaskCard extends BaseCard {
         message: string;
         options: [];
         properties: RecordedTaskCardProperties;
-        routingOptions: RoutingOptions<Comparator.GivenUp>;
+        routingOptions: RoutingOptions<"given_up">;
     };
-    type: CardType.RecordedTask;
+    type: "recordedtask";
 }
 interface Labels {
     left: string;
@@ -2054,11 +1982,7 @@ interface RatingIcon {
     idx?: number;
     svg: string;
 }
-declare enum ScaleLabelType {
-    Number = "number",
-    Smiley = "smiley",
-    Star = "star"
-}
+type ScaleLabelType = "number" | "smiley" | "star";
 interface LikertCard extends BaseCard {
     props: {
         labels: Labels;
@@ -2074,9 +1998,9 @@ interface LikertCard extends BaseCard {
             scaleLabelType: ScaleLabelType;
             required: boolean;
         };
-        routingOptions: RoutingOptions<Comparator.Equal | Comparator.GivenUp | Comparator.GreaterThan | Comparator.GreaterThanOrEqual | Comparator.LessThan | Comparator.LessThanOrEqual | Comparator.NotEqual>;
+        routingOptions: RoutingOptions<"eq" | "given_up" | "gt" | "gte" | "lt" | "lte" | "neq">;
     };
-    type: CardType.Likert;
+    type: "likert";
 }
 interface OpenTextCard extends BaseCard {
     props: {
@@ -2087,14 +2011,15 @@ interface OpenTextCard extends BaseCard {
             buttonText?: string;
             captionText?: string;
             conceptUrl: ConceptUrl;
+            footerHtml?: string;
             openTextPlaceholder?: string;
             required: boolean;
             richTextBody: RichTextBody;
             skipButtonText?: string;
         };
-        routingOptions: RoutingOptions<Comparator.Contains | Comparator.DoesNotContain>;
+        routingOptions: RoutingOptions<"contains" | "notcontains">;
     };
-    type: CardType.Open;
+    type: "open";
 }
 interface MultipleChoiceOption {
     createdAt: string;
@@ -2120,6 +2045,15 @@ interface CommonMultipleChoiceProps {
         buttonText?: string;
         captionText: string;
         conceptUrl: ConceptUrl;
+        isDropdown?: boolean;
+        /**
+         * Placeholder text on the dropdown button when no items are selected
+         */
+        dropdownPlaceholderText?: string;
+        /**
+         * Text when multiple items are selected, such as "2 items selected" / "3 items selected"
+         */
+        dropdownMultiselectedText?: string;
         randomize: "none" | "all";
         required: boolean;
     };
@@ -2129,17 +2063,17 @@ interface MultiChoiceCard<C extends Comparator = DefaultComparator> extends Base
         routingOptions: RoutingOptions<C>;
     };
 }
-interface MultipleChoiceSingleSelectCard extends MultiChoiceCard<Comparator.Equal | Comparator.NotEqual | Comparator.ListAtLeastOne | Comparator.DoesNotInclude> {
-    type: CardType.MultipleChoice;
+interface MultipleChoiceSingleSelectCard extends MultiChoiceCard<"eq" | "neq" | "list_alo" | "list_dni"> {
+    type: "multiplechoice";
 }
-interface MultipleChoiceMultiSelectCard extends MultiChoiceCard<Comparator.ListAll | Comparator.ListAtLeastOne | Comparator.ListExact | Comparator.DoesNotInclude> {
-    type: CardType.MultipleSelect;
+interface MultipleChoiceMultiSelectCard extends MultiChoiceCard<"list_all" | "list_alo" | "list_exact" | "list_dni"> {
+    type: "multipleselect";
 }
 interface MatrixCard extends BaseCard {
     props: {
         options: MultipleChoiceOption[];
         message: string;
-        routingOptions: RoutingOptions<Comparator.Skipped | Comparator.Partial | Comparator.Answered>;
+        routingOptions: RoutingOptions<"skipped" | "partial" | "answered">;
         properties: {
             buttonText?: string;
             captionText: string;
@@ -2152,7 +2086,7 @@ interface MatrixCard extends BaseCard {
             required: boolean;
         };
     };
-    type: CardType.Matrix;
+    type: "matrix";
 }
 interface NPSCard extends BaseCard {
     props: {
@@ -2172,9 +2106,9 @@ interface NPSCard extends BaseCard {
             };
             required: boolean;
         };
-        routingOptions: RoutingOptions<Comparator.Equal | Comparator.GreaterThan | Comparator.GreaterThanOrEqual | Comparator.LessThan | Comparator.LessThanOrEqual | Comparator.NotEqual>;
+        routingOptions: RoutingOptions<"eq" | "gt" | "gte" | "lt" | "lte" | "neq">;
     };
-    type: CardType.NPS;
+    type: "nps";
 }
 interface VideoVoiceCard extends BaseCard {
     props: {
@@ -2184,6 +2118,7 @@ interface VideoVoiceCard extends BaseCard {
             buttonText: string;
             captionText: string;
             conceptUrl: null;
+            hideRecordedPrompt?: boolean;
             mediaType: "video" | "audio";
             required: boolean;
             skipButtonText: string;
@@ -2192,14 +2127,15 @@ interface VideoVoiceCard extends BaseCard {
         };
         routingOptions: RoutingOptions;
     };
-    type: CardType.VideoVoice;
+    type: "videovoice";
 }
 type Card = TextUrlPromptCard | ConsentLegalCard | RecordedTaskCard | LikertCard | OpenTextCard | MatrixCard | MultipleChoiceSingleSelectCard | MultipleChoiceMultiSelectCard | NPSCard | VideoVoiceCard;
 
-type MatchType = "exactly" | "legacy";
+type InteractiveMatchType = "exactly" | "legacy";
+type PageUrlMatchType = "contains" | "exactly" | "legacy" | "notContains" | "regex" | "startsWith";
 interface InteractiveEvent {
     id: number;
-    matchType: MatchType;
+    matchType: InteractiveMatchType;
     name: string;
     pattern: string;
     properties: {
@@ -2210,19 +2146,22 @@ interface InteractiveEvent {
 }
 interface PageUrlEvent {
     id: number;
-    matchType: MatchType | "contains" | "notContains" | "regex" | "startsWith";
+    matchType: PageUrlMatchType;
     pattern: string;
 }
 
 declare enum DismissReason {
     Closed = "close.click",
     Complete = "survey.completed",
+    FeedbackClosed = "feedback.closed",
     PageChange = "page.change",
     API = "api",
     Override = "override"
 }
+type StudyType = "feedbackButton" | "inProductSurvey";
 declare enum SprigEvent {
     ReplayCapture = "replay.capture",
+    FeedbackButtonLoaded = "feedback.button.loaded",
     SDKReady = "sdk.ready",
     SurveyAppeared = "survey.appeared",
     SurveyClosed = "survey.closed",
@@ -2238,10 +2177,8 @@ declare enum SprigEvent {
     VisitorIDUpdated = "visitor.id.updated",
     QuestionAnswered = "question.answered"
 }
-declare enum SprigEventData {
-    SurveyId = "survey.id"
-}
 declare const EVENTS: {
+    FEEDBACK_BUTTON_LOADED: SprigEvent;
     SDK_READY: SprigEvent;
     SURVEY_APPEARED: SprigEvent;
     SURVEY_CLOSED: SprigEvent;
@@ -2265,65 +2202,50 @@ declare const EVENTS: {
             PAGE_CHANGE: DismissReason;
             OVERRIDE: DismissReason;
         };
-        SURVEY_ID: SprigEventData;
+        SURVEY_ID: string;
     };
 };
-declare const enum InternalEventName {
-    VerifyViewVersion = "verify.view.version",
-    CurrentQuestion = "survey.question",
-    ViewPrototypeClick = "question.prototype.click",
-    ViewAgreementClick = "question.agreement.click",
-    RecordedTaskStart = "recorded.task.start",
-    RecordedTaskPermissionScreen = "recorded.task.permission.screen",
-    SurveyComplete = "survey.complete"
-}
-declare const enum InternalEventData {
-    ViewVersion = "view.version",
-    QuestionId = "qid",
-    Props = "props"
-}
 
-interface RecordedTaskResponseType {
-    questionId: number;
-    type: CardType;
-    value: RecordedTaskResponseValueType;
+type Metric = "sdk_event_queue_latency_seconds" | "sdk_replay_add_event_batch_seconds" | "sdk_replay_cleanup_seconds" | "sdk_replay_compression_seconds" | "sdk_replay_get_events_between_seconds" | "sdk_replay_snapshot_seconds";
+type ThresholdType = "max" | "min";
+interface MetricThreshold {
+    metric: Metric;
+    type: ThresholdType;
+    value: number;
 }
 
-declare enum ReplayDurationType {
-    After = "after",
-    Before = "before",
-    BeforeAndAfter = "beforeAndAfter"
-}
-declare enum ReplayEventType {
-    Click = "Sprig_Click",
-    Event = "Sprig_TrackEvent",
-    PageView = "Sprig_PageView",
-    SurveyShown = "Sprig_ShowSurvey",
-    SurveySubmitted = "Sprig_SubmitSurvey",
-    Noop = "Sprig_Noop"
-}
+type ReplayDurationType = "after" | "before" | "beforeAndAfter";
 type EventDigest = {
     timestamp: number;
-    type: ReplayEventType.Click;
+    type: "Sprig_Click";
 } | {
     timestamp: number;
     name: string;
-    type: ReplayEventType.Event;
+    type: "Sprig_TrackEvent";
 } | {
     timestamp: number;
-    type: ReplayEventType.PageView;
+    type: "Sprig_PageView";
     url: string;
 } | {
     timestamp: number;
     surveyId: string;
-    type: ReplayEventType.SurveyShown;
+    type: "Sprig_ShowSurvey";
 } | {
     timestamp: number;
     surveyId: string;
-    type: ReplayEventType.SurveySubmitted;
+    type: "Sprig_SubmitSurvey";
 };
 
+interface RecordedTaskResponseType {
+    questionId: number;
+    type: CardType;
+    value: RecordedTaskResponseValueType;
+}
+
 interface MobileReplayConfig {
+    mobileMetricsReportingEnabled?: boolean;
+    metricsReportingInterval?: number;
+    metricsThresholds?: MetricThreshold[];
     maxMobileReplayDurationSeconds?: number;
     mobileReplaySettings?: {
         hideAllFormContents: boolean;
@@ -2332,26 +2254,32 @@ interface MobileReplayConfig {
     };
 }
 type SprigEventMap = {
-    [InternalEventName.CurrentQuestion]: [
+    "survey.question": [
         {
-            [InternalEventData.QuestionId]: number;
-            [InternalEventData.Props]: unknown;
+            qid: number;
+            props: unknown;
         }
     ];
-    [InternalEventName.RecordedTaskPermissionScreen]: [];
-    [InternalEventName.RecordedTaskStart]: [];
-    [InternalEventName.SurveyComplete]: [];
-    [InternalEventName.VerifyViewVersion]: [
+    "recorded.task.permission.screen": [];
+    "recorded.task.start": [];
+    "survey.complete": [number];
+    "verify.view.version": [
         {
-            [InternalEventData.ViewVersion]: string;
+            "view.version": string;
         }
     ];
     [SprigEvent.CloseSurveyOnOverlayClick]: [];
+    [SprigEvent.FeedbackButtonLoaded]: [
+        {
+            name: string;
+            "survey.id"?: number;
+        }
+    ];
     [SprigEvent.SDKReady]: [MobileReplayConfig];
     [SprigEvent.SurveyAppeared]: [
         {
             name: string;
-            [SprigEventData.SurveyId]: number;
+            "survey.id": number;
         }
     ];
     [SprigEvent.SurveyDimensions]: [
@@ -2365,6 +2293,7 @@ type SprigEventMap = {
         {
             initiator?: string;
             name: string;
+            studyType?: StudyType;
         }
     ];
     [SprigEvent.SurveyFadingOut]: [];
@@ -2386,19 +2315,20 @@ type SprigEventMap = {
     [SprigEvent.SurveyPresented]: [
         {
             name: string;
-            [SprigEventData.SurveyId]: number;
+            "survey.id": number;
         }
     ];
     [SprigEvent.SurveyWillClose]: [
         {
             initiator: DismissReason;
             name?: string;
+            studyType?: StudyType;
         }
     ];
     [SprigEvent.SurveyWillPresent]: [
         {
             name: string;
-            [SprigEventData.SurveyId]: number;
+            "survey.id": number;
         }
     ];
     [SprigEvent.VisitorIDUpdated]: [{
@@ -2418,47 +2348,56 @@ type SprigEventMap = {
             uploadId: string;
             seconds: number;
             replayType: ReplayDurationType;
-            generateVideoUploadUrlPayload: object;
+            generateVideoUploadUrlPayload: {
+                isReplay: boolean;
+                mediaRecordingUid: string;
+                mediaType: MediaType;
+                questionId: number;
+                responseGroupUid: string;
+                surveyId: number;
+                updatedAt: string;
+                visitorId: string | null;
+            };
             surveyId: number;
         }
     ];
-    [SprigRecordingEvent.AvPermission]: [
+    "av.permission": [
         {
-            [SprigRecordingEventData.StreamReadyCallback]: (avStream: MediaStream | null, captureStream?: MediaStream | null) => void;
-            [SprigRecordingEventData.PermissionDescriptors]: AvPermission[];
+            "stream.ready": (avStream: MediaStream | null, captureStream?: MediaStream | null) => void;
+            "permission.descriptors": AvPermission[];
         }
     ];
-    [SprigRecordingEvent.BeginRecording]: [
+    "begin.recording": [
         {
-            [SprigRecordingEventData.RecordingMediaTypes]: MediaType[];
-            [SprigRecordingEventData.StartRecordingCallback]: (mediaRecordingUids: UUID[]) => void;
+            "recording.media.types": MediaType[];
+            "start.recording.callback": (mediaRecordingUids: UUID[]) => void;
         }
     ];
-    [SprigRecordingEvent.FinishTask]: [
+    "finish.task": [
         {
-            [SprigRecordingEventData.BeginCallback]: (mediaRecordingUid: UUID) => void;
-            [SprigRecordingEventData.CurrentIndex]: number;
-            [SprigRecordingEventData.PassthroughData]: PassthroughData;
-            [SprigRecordingEventData.ProgressCallback]: (mediaRecordingUid: UUID, data: {
+            "begin.callback": (mediaRecordingUid: UUID) => void;
+            "current.index": number;
+            "passthrough.data": PassthroughData;
+            "progress.callback": (mediaRecordingUid: UUID, data: {
                 detail: number;
             }) => void;
-            [SprigRecordingEventData.TaskCompleteCallback]: (taskDurationMillisecond: number) => void;
-            [SprigRecordingEventData.TaskResponse]: RecordedTaskResponseType;
-            [SprigRecordingEventData.UploadCallback]: (mediaRecordingUid: UUID | null, successOrError: true | unknown) => void;
+            "task.complete.callback": (taskDurationMillisecond: number) => void;
+            "task.response": RecordedTaskResponseType;
+            "upload.callback": (mediaRecordingUid: UUID | null, successOrError: true | unknown) => void;
         }
     ];
-    [SprigRecordingEvent.PermissionStatus]: [
+    "permission.status": [
         {
-            [SprigRecordingEventData.PermissionStatusCallback]: (avStream: MediaStream | undefined, hasVideoPermission: boolean, hasScreenPermission: boolean, captureStream: MediaStream | undefined) => void;
+            "permission.status.callback": (avStream: MediaStream | undefined, hasVideoPermission: boolean, hasScreenPermission: boolean, captureStream: MediaStream | undefined) => void;
         }
     ];
-    [SprigRecordingEvent.ScreenPermission]: [
+    "screen.permission": [
         {
-            [SprigRecordingEventData.ScreenPermissionRequested]?: (data: boolean) => void;
-            [SprigRecordingEventData.StreamReadyCallback]: (avStream: MediaStream | null, captureStream: MediaStream | null) => void;
+            "screen.permission.requested"?: (data: boolean) => void;
+            "stream.ready.callback": (avStream: MediaStream | null, captureStream: MediaStream | null) => void;
         }
     ];
-    [SprigRecordingEvent.StartTask]: [];
+    "start.task": [];
 };
 declare const eventEmitter: Emitter<SprigEventMap>;
 type SprigEventEmitter = typeof eventEmitter;
@@ -2471,42 +2410,20 @@ declare const LogLevels: {
 };
 type LogLevel = (typeof LogLevels)[keyof typeof LogLevels];
 
-declare const enum FramePosition {
-    BottomLeft = "bottomLeft",
-    BottomRight = "bottomRight",
-    Center = "center",
-    TopLeft = "topLeft",
-    TopRight = "topRight"
-}
-declare const enum HttpHeader {
-    Error = "x-ul-error",
-    EnvironmentID = "x-ul-environment-id",
-    InstallationMethod = "x-ul-installation-method",
-    PartnerAnonymousId = "x-ul-anonymous-id",
-    Platform = "userleap-platform",
-    PreviewMode = "x-ul-preview-mode",
-    UserID = "x-ul-user-id",
-    VisitorID = "x-ul-visitor-id"
-}
-declare const enum Platform {
-    Email = "email",
-    Link = "link",
-    Web = "web"
-}
-declare const enum InstallationMethod {
-    Npm = "web-npm",
-    NpmBundled = "web-npm-bundled",
-    Gtm = "web-gtm",
-    Segment = "web-segment",
-    SegmentAndroid = "android-segment",
-    SegmentReactNative = "react-native-segment",
-    SegmentIOS = "ios-segment",
-    Snippet = "web-snippet"
-}
+type FramePosition = "bottomLeft" | "bottomRight" | "center" | "topLeft" | "topRight";
+type Platform = "email" | "link" | "web";
+type InstallationMethod = "web-npm" | "web-npm-bundled" | "web-gtm" | "web-segment" | "android-segment" | "react-native-segment" | "ios-segment" | "web-snippet";
 interface Answer {
     questionId: number;
     value: unknown;
 }
+type FeedbackPlacement = "center-left" | "center-right" | "bottom-left" | "bottom-right";
+type FeedbackDesktopDisplay = "center-modal" | "slider";
+interface AppProductConfig {
+    framePosition?: FramePosition;
+    desktopDisplay?: FeedbackDesktopDisplay;
+    placement?: FeedbackPlacement;
+}
 interface Config extends MobileReplayConfig {
     allResponses: unknown[];
     answers?: Answer[];
@@ -2550,23 +2467,25 @@ interface Config extends MobileReplayConfig {
         "accept-language"?: string;
         /** @example "Bearer 123" */
         Authorization?: string;
-        "Content-Type": string;
-        "userleap-platform": Platform;
+        "Content-Type"?: string;
+        "userleap-platform": Platform | "ios" | "android" | "video_recorder";
         /** @example "SJcVfq-7QQ" */
-        [HttpHeader.EnvironmentID]?: string;
-        [HttpHeader.InstallationMethod]: InstallationMethod;
-        [HttpHeader.PartnerAnonymousId]?: string;
-        [HttpHeader.PreviewMode]?: string;
+        "x-ul-environment-id"?: string;
+        "x-ul-installation-method": InstallationMethod;
+        "x-ul-anonymous-id"?: string;
+        "x-ul-error"?: string;
+        "x-ul-preview-mode"?: string;
         /** @example "2.18.0" */
-        "x-ul-sdk-version": string;
+        "x-ul-sdk-version"?: string;
         /** For web-bundled sdk */
         "x-ul-package-version"?: string;
-        [HttpHeader.UserID]?: string;
-        [HttpHeader.VisitorID]?: UUID;
+        "x-ul-user-id"?: string;
+        "x-ul-visitor-id"?: string;
     };
     installationMethod?: InstallationMethod;
     interactiveEvents: InteractiveEvent[];
     interactiveEventsHandler?: (e: MouseEvent) => void;
+    isOnQuestionsTab?: boolean;
     isPreview?: boolean;
     launchDarklyEnabled?: boolean;
     locale: string;
@@ -2590,6 +2509,7 @@ interface Config extends MobileReplayConfig {
     platform?: Platform;
     previewKey?: string | null;
     previewLanguage?: string;
+    productConfig?: AppProductConfig;
     replayNonce?: string;
     replaySettings?: object;
     requireUserIdForTracking: boolean;
@@ -2599,6 +2519,7 @@ interface Config extends MobileReplayConfig {
     slugName: null;
     startingQuestionIdx?: number | null;
     styleNonce?: string;
+    studyType?: StudyType;
     surveyId: number;
     tabTitle: string;
     ulEvents: typeof SprigEvent;
@@ -2638,10 +2559,7 @@ declare class SprigQueue {
     empty(): void;
 }
 
-declare enum SurveyState {
-    Ready = "ready",
-    NoSurvey = "no survey"
-}
+type SurveyState = "ready" | "no survey";
 
 declare namespace optimizely {
   interface Optimizely {
@@ -2685,6 +2603,7 @@ declare namespace optimizely {
 declare namespace sprigConfig {
   type IdentifyResult = Promise<
     | {
+        error?: Error;
         success: boolean;
         message?: string;
         surveyState?: SurveyState;
@@ -2722,6 +2641,7 @@ declare namespace sprigConfig {
     }) => Promise<string | null>;
     _previewSurvey: (surveyTemplateId: UUID) => void;
     _reviewSurvey: (surveyId: number) => void;
+    _reportMetric: (name: Metric, value: number) => void;
 
     // external apis
     addListener: (event: SprigEvent, listener: SprigListener) => Promise<void>;
@@ -2888,13 +2808,17 @@ declare class SprigAPI {
      * Include external events emitted from Sprig
      */
     UPDATES: {
+        FEEDBACK_BUTTON_LOADED: SprigEvent;
         SDK_READY: SprigEvent;
         SURVEY_APPEARED: SprigEvent;
         SURVEY_CLOSED: SprigEvent;
         SURVEY_DIMENSIONS: SprigEvent;
         SURVEY_FADING_OUT: SprigEvent;
         SURVEY_HEIGHT: SprigEvent;
-        SURVEY_WIDTH: SprigEvent;
+        SURVEY_WIDTH: SprigEvent; /**
+         * Track an event to show survey if eligible
+         * @param eventName name of event to track
+         */
         SURVEY_PRESENTED: SprigEvent;
         SURVEY_LIFE_CYCLE: SprigEvent;
         SURVEY_WILL_CLOSE: SprigEvent;
@@ -2911,7 +2835,7 @@ declare class SprigAPI {
                 PAGE_CHANGE: DismissReason;
                 OVERRIDE: DismissReason;
             };
-            SURVEY_ID: SprigEventData;
+            SURVEY_ID: string;
         };
     };
     /**