@sprig-technologies/sprig-browser 2.24.5 → 2.24.7

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;
@@ -849,6 +877,7 @@ interface Config {
     customMetadata?: Record<string, unknown>;
     customStyles: string;
     dismissOnPageChange: boolean;
+    forceBrandedLogo?: boolean;
     endCard?: {
         headline: string;
         subheader?: string;
@@ -856,6 +885,8 @@ interface Config {
     /** @example "SJcVfq-7QQ" */
     envId: string;
     environmentId?: string;
+    exitOnOverlayClick?: boolean;
+    exitOnOverlayClickMobile?: boolean;
     eventEmitFn: SprigEventEmitter["emit"];
     fontFamily?: string;
     fontFamilyURL: undefined;
@@ -891,6 +922,7 @@ interface Config {
     maxAttrValueLength: number;
     maxEmailLength: number;
     maxEventLength: number;
+    maxReplayDurationSeconds?: number;
     maxUserIdLength: number;
     mobileSDKVersion: undefined;
     mode?: string;
@@ -914,6 +946,7 @@ interface Config {
     surveyId: number;
     tabTitle: string;
     ulEvents: typeof SprigEvent;
+    UpChunk: Window["UpChunk"];
     useDesktopPrototype?: boolean;
     useMobileStyling: boolean;
     userId: UUID | null;
@@ -926,33 +959,34 @@ interface Config {
     };
 }
 
-declare enum SurveyState {
-    Ready = "ready",
-    NoSurvey = "no survey"
-}
-
-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 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 {
@@ -993,9 +1027,54 @@ declare namespace optimizely {
   }
 }
 
+declare namespace upchunk {
+  type AllowedMethods = "PUT" | "POST" | "PATCH";
+
+  //Adapted from here: https://github.com/muxinc/upchunk/blob/master/src/upchunk.ts
+  interface UpChunkOptions {
+    endpoint: string | ((file?: File) => Promise<string>);
+    file: File;
+    method?: AllowedMethods;
+    headers?: Headers;
+    maxFileSize?: number;
+    chunkSize?: number;
+    attempts?: number;
+    delayBeforeAttempt?: number;
+    retryCodes?: number[];
+    dynamicChunkSize?: boolean;
+    maxChunkSize?: number;
+    minChunkSize?: number;
+  }
+
+  type UpChunkEventName =
+    | "attempt"
+    | "attemptFailure"
+    | "chunkSuccess"
+    | "error"
+    | "offline"
+    | "online"
+    | "progress"
+    | "success";
+
+  interface UpChunk {
+    startTime: number;
+    on: (eventName: UpChunkEventName, fn: (event: CustomEvent) => void) => void;
+  }
+  interface UpChunkModule {
+    createUpload: (options: UpChunkOptions) => 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 {
@@ -1008,17 +1087,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;
@@ -1130,6 +1222,7 @@ declare global {
     optimizely?: optimizely.Optimizely;
     optimizelyDatafile?: object;
     previewMode?: unknown;
+    UpChunk: upchunk.UpChunkModule;
     _Sprig?: sprigConfig.WindowSprig;
     Sprig: sprigConfig.WindowSprig;
     UserLeap: sprigConfig.WindowSprig;
@@ -1165,7 +1258,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;