@sprig-technologies/sprig-browser 2.24.4 → 2.24.6

package/dist/index.d.ts

@@ -351,6 +351,34 @@ interface PassthroughData {
     responseGroupUid: UUID;
 }
 
+interface Experiment {
+    id: string;
+    variation?: string;
+}
+
+type QueueItem = [string, ...unknown[]] | (() => void);
+declare class SprigQueue {
+    paused: boolean;
+    queue: QueueItem[];
+    ul: WindowSprig;
+    constructor(ul: WindowSprig, queue: QueueItem[]);
+    flush(queue: QueueItem[]): void;
+    isPaused(): boolean;
+    pause(): void;
+    unpause(): void;
+    push(action: QueueItem): void;
+    perform(func: () => void): void | Promise<unknown>;
+    /**
+     * Removes all queued items
+     */
+    empty(): void;
+}
+
+declare enum SurveyState {
+    Ready = "ready",
+    NoSurvey = "no survey"
+}
+
 interface RecordedTaskResponseValueType {
     mediaRecordingUids?: string[] | null;
     taskDurationMillisecond?: number;
@@ -374,7 +402,7 @@ declare const enum CardType {
     Uploading = "uploading",
     VideoVoice = "videovoice"
 }
-declare type ConceptUrl = string | null;
+type ConceptUrl = string | null;
 interface BaseCard {
     name: number;
     surveyId: number;
@@ -398,28 +426,28 @@ declare const enum Comparator {
     Contains = "contains",
     DoesNotContain = "notcontains"
 }
-declare type DefaultComparator = Comparator.Answered | Comparator.Skipped;
-declare type RoutingOption<C extends Comparator = DefaultComparator> = OldRoutingOption<C> | GroupRoutingOption;
-declare type OldRoutingOption<C extends Comparator = DefaultComparator> = {
+type DefaultComparator = Comparator.Answered | Comparator.Skipped;
+type RoutingOption<C extends Comparator = DefaultComparator> = OldRoutingOption<C> | GroupRoutingOption;
+type OldRoutingOption<C extends Comparator = DefaultComparator> = {
     comparator: C;
     target: number;
     /** @example '', 'option_2', ['option_1'] */
     value: number | string | string[];
 };
-declare type GroupRoutingOption = {
+type GroupRoutingOption = {
     group: (RoutingGroupOption | BooleanOperator)[];
     target: number;
 };
-declare type RoutingGroupOption = {
+type RoutingGroupOption = {
     comparator: Comparator;
     questionIndex: number;
     value: number | string | string[] | {
         skipped: true;
     } | null | undefined;
 };
-declare type RoutingOptions<C extends Comparator = DefaultComparator> = RoutingOption<C | DefaultComparator>[] | null;
+type RoutingOptions<C extends Comparator = DefaultComparator> = RoutingOption<C | DefaultComparator>[] | null;
 /** @example <p>Body</p> */
-declare type RichTextBody = string;
+type RichTextBody = string;
 declare const enum PromptActionType {
     Continue = "CONTINUE",
     External = "EXTERNAL"
@@ -514,7 +542,7 @@ interface CompleteTaskPage extends BaseTaskPage {
     taskDetail: string;
     type: RecordedTaskPageType.CompleteTask;
 }
-declare type RecordedTaskPage = PermissionTaskPage | ScreenTaskPage | StartTaskPage | CompleteTaskPage;
+type RecordedTaskPage = PermissionTaskPage | ScreenTaskPage | StartTaskPage | CompleteTaskPage;
 interface RecordedTaskCardProperties {
     captionText: string;
     conceptUrl: ConceptUrl;
@@ -659,7 +687,7 @@ interface VideoVoiceCard extends BaseCard {
     };
     type: CardType.VideoVoice;
 }
-declare type Card = TextUrlPromptCard | ConsentLegalCard | RecordedTaskCard | LikertCard | OpenTextCard | MultipleChoiceSingleSelectCard | MultipleChoiceMultiSelectCard | NPSCard | VideoVoiceCard;
+type Card = TextUrlPromptCard | ConsentLegalCard | RecordedTaskCard | LikertCard | OpenTextCard | MultipleChoiceSingleSelectCard | MultipleChoiceMultiSelectCard | NPSCard | VideoVoiceCard;
 
 interface RecordedTaskResponseType {
     questionId: number;
@@ -667,7 +695,7 @@ interface RecordedTaskResponseType {
     value: RecordedTaskResponseValueType;
 }
 
-declare type SprigEventMap = {
+type SprigEventMap = {
     [InternalEventName.CurrentQuestion]: [
         {
             [InternalEventData.QuestionId]: number;
@@ -774,9 +802,9 @@ declare type SprigEventMap = {
     [SprigRecordingEvent.StartTask]: [];
 };
 declare const eventEmitter: Emitter<SprigEventMap>;
-declare type SprigEventEmitter = typeof eventEmitter;
+type SprigEventEmitter = typeof eventEmitter;
 
-declare type MatchType = "exactly" | "legacy";
+type MatchType = "exactly" | "legacy";
 interface InteractiveEvent {
     id: number;
     matchType: MatchType;
@@ -856,6 +884,8 @@ interface Config {
     /** @example "SJcVfq-7QQ" */
     envId: string;
     environmentId?: string;
+    exitOnOverlayClick?: boolean;
+    exitOnOverlayClickMobile?: boolean;
     eventEmitFn: SprigEventEmitter["emit"];
     fontFamily?: string;
     fontFamilyURL: undefined;
@@ -891,6 +921,7 @@ interface Config {
     maxAttrValueLength: number;
     maxEmailLength: number;
     maxEventLength: number;
+    maxReplayDurationSeconds?: number;
     maxUserIdLength: number;
     mobileSDKVersion: undefined;
     mode?: string;
@@ -927,33 +958,34 @@ interface Config {
     };
 }
 
-declare enum SurveyState {
-    Ready = "ready",
-    NoSurvey = "no survey"
-}
-
-interface Experiment {
-    id: string;
-    variation?: string;
-}
-
-declare type QueueItem = [string, ...unknown[]] | (() => void);
-declare class SprigQueue {
-    paused: boolean;
-    queue: QueueItem[];
-    ul: WindowSprig;
-    constructor(ul: WindowSprig, queue: QueueItem[]);
-    flush(queue: QueueItem[]): void;
-    isPaused(): boolean;
-    pause(): void;
-    unpause(): void;
-    push(action: QueueItem): void;
-    perform(func: () => void): void | Promise<unknown>;
-    /**
-     * Removes all queued items
-     */
-    empty(): void;
+declare enum ReplayEventType {
+    Click = "Sprig_Click",
+    Event = "Sprig_TrackEvent",
+    PageView = "Sprig_PageView",
+    SurveyShown = "Sprig_ShowSurvey",
+    SurveySubmitted = "Sprig_SubmitSurvey",
+    Noop = "Sprig_Noop"
 }
+type EventDigest = {
+    timestamp: number;
+    type: ReplayEventType.Click;
+} | {
+    timestamp: number;
+    name: string;
+    type: ReplayEventType.Event;
+} | {
+    timestamp: number;
+    type: ReplayEventType.PageView;
+    url: string;
+} | {
+    timestamp: number;
+    surveyId: string;
+    type: ReplayEventType.SurveyShown;
+} | {
+    timestamp: number;
+    surveyId: string;
+    type: ReplayEventType.SurveySubmitted;
+};
 
 declare namespace optimizely {
   interface Optimizely {
@@ -1034,7 +1066,14 @@ declare namespace upchunk {
 
 declare namespace sprigConfig {
   type IdentifyResult = Promise<
-    { success: boolean; message?: string } | undefined
+    | {
+        success: boolean;
+        message?: string;
+        surveyState?: SurveyState;
+        surveyId?: number;
+        responseGroupUid?: string;
+      }
+    | undefined
   >;
 
   interface TrackPayload {
@@ -1047,17 +1086,30 @@ declare namespace sprigConfig {
   }
 
   interface SprigAPIActions {
+    // internal apis
+    _completeSessionReplay: (payload: {
+      surveyId: number;
+      responseGroupUuid: string;
+      eventDigest?: EventDigest[];
+    }) => Promise<void>;
+    _generateVideoUploadUrl: (body: {
+      mediaRecordingUid?: string;
+      mediaType?: MediaType;
+      questionId?: number;
+      responseGroupUid?: string;
+      surveyId?: number;
+      updatedAt?: string;
+      visitorId?: string | null;
+    }) => Promise<string | null>;
     _previewSurvey: (surveyTemplateId: UUID) => void;
     _reviewSurvey: (surveyId: number) => void;
+
+    // external apis
     addListener: (event: SprigEvent, listener: SprigListener) => Promise<void>;
     addSurveyListener: (listener: SprigListener) => Promise<void>;
     applyStyles: (styleString: string) => void;
     dismissActiveSurvey: (reason?: DismissReason) => void;
-    displaySurvey: (surveyId: number) => Promise<{
-      success: boolean;
-      message?: string;
-      surveyState: SurveyState;
-    }>;
+    displaySurvey: (surveyId: number) => IdentifyResult;
     identifyAndSetAttributes: (payload: {
       anonymousId?: string;
       attributes?: SprigAttributes;
@@ -1147,7 +1199,7 @@ declare namespace sprigConfig {
       partnerAnonymousId: string | null;
       replayNonce?: string;
       reportError: (name: string, err: Error, extraInfo?: object) => void;
-      sampleRate?: unknown; // TODO: determine type
+      sampleRate?: number;
       token: string | null;
       UPDATES: typeof EVENTS;
       viewSDKURL?: string;
@@ -1205,7 +1257,8 @@ declare class SprigAPI {
         SURVEY_WILL_CLOSE: SprigEvent;
         SURVEY_WILL_PRESENT: SprigEvent;
         QUESTION_ANSWERED: SprigEvent;
-        CLOSE_SURVEY_ON_OVERLAY_CLICK: SprigEvent; /**
+        CLOSE_SURVEY_ON_OVERLAY_CLICK: SprigEvent;
+        /**
          * Attach an email address to visitor
          */
         VISITOR_ID_UPDATED: SprigEvent;
@@ -1315,7 +1368,7 @@ declare class SprigAPI {
      */
     teardown(): void;
 }
-declare type NpmConfig = {
+type NpmConfig = {
     envId?: string;
     environmentId?: string;
     path?: string;
@@ -1328,7 +1381,7 @@ declare const sprig: {
      */
     configure: (config: NpmConfig) => sprigConfig.WindowSprig;
 };
-declare type WindowSprig$1 = typeof window.Sprig;
+type WindowSprig$1 = typeof window.Sprig;
 
 declare const _default: {
     sprig: {