@sprig-technologies/sprig-browser 2.25.0 → 2.26.0

package/dist/index.d.ts

@@ -992,38 +992,7 @@ declare const utils_d_shadowHostInDom: typeof shadowHostInDom;
 declare const utils_d_throttle: typeof throttle;
 declare const utils_d_uniqueTextMutations: typeof uniqueTextMutations;
 declare namespace utils_d {
-  export {
-    utils_d_AppendedIframe as AppendedIframe,
-    utils_d_StyleSheetMirror as StyleSheetMirror,
-    utils_d__mirror as _mirror,
-    utils_d_getBaseDimension as getBaseDimension,
-    utils_d_getNestedRule as getNestedRule,
-    utils_d_getPositionsAndIndex as getPositionsAndIndex,
-    utils_d_getRootShadowHost as getRootShadowHost,
-    utils_d_getShadowHost as getShadowHost,
-    utils_d_getWindowHeight as getWindowHeight,
-    utils_d_getWindowScroll as getWindowScroll,
-    utils_d_getWindowWidth as getWindowWidth,
-    utils_d_hasShadowRoot as hasShadowRoot,
-    utils_d_hookSetter as hookSetter,
-    utils_d_inDom as inDom,
-    utils_d_isAncestorRemoved as isAncestorRemoved,
-    utils_d_isBlocked as isBlocked,
-    utils_d_isIgnored as isIgnored,
-    utils_d_isSerialized as isSerialized,
-    utils_d_isSerializedIframe as isSerializedIframe,
-    utils_d_isSerializedStylesheet as isSerializedStylesheet,
-    utils_d_iterateResolveTree as iterateResolveTree,
-    utils_d_legacy_isTouchEvent as legacy_isTouchEvent,
-    utils_d_nowTimestamp as nowTimestamp,
-    utils_d_on as on,
-    utils_d_patch as patch,
-    utils_d_polyfill as polyfill,
-    utils_d_queueToResolveTrees as queueToResolveTrees,
-    utils_d_shadowHostInDom as shadowHostInDom,
-    utils_d_throttle as throttle,
-    utils_d_uniqueTextMutations as uniqueTextMutations,
-  };
+  export { type utils_d_AppendedIframe as AppendedIframe, utils_d_StyleSheetMirror as StyleSheetMirror, utils_d__mirror as _mirror, utils_d_getBaseDimension as getBaseDimension, utils_d_getNestedRule as getNestedRule, utils_d_getPositionsAndIndex as getPositionsAndIndex, utils_d_getRootShadowHost as getRootShadowHost, utils_d_getShadowHost as getShadowHost, utils_d_getWindowHeight as getWindowHeight, utils_d_getWindowScroll as getWindowScroll, utils_d_getWindowWidth as getWindowWidth, utils_d_hasShadowRoot as hasShadowRoot, utils_d_hookSetter as hookSetter, utils_d_inDom as inDom, utils_d_isAncestorRemoved as isAncestorRemoved, utils_d_isBlocked as isBlocked, utils_d_isIgnored as isIgnored, utils_d_isSerialized as isSerialized, utils_d_isSerializedIframe as isSerializedIframe, utils_d_isSerializedStylesheet as isSerializedStylesheet, utils_d_iterateResolveTree as iterateResolveTree, utils_d_legacy_isTouchEvent as legacy_isTouchEvent, utils_d_nowTimestamp as nowTimestamp, utils_d_on as on, utils_d_patch as patch, utils_d_polyfill as polyfill, utils_d_queueToResolveTrees as queueToResolveTrees, utils_d_shadowHostInDom as shadowHostInDom, utils_d_throttle as throttle, utils_d_uniqueTextMutations as uniqueTextMutations };
 }
 
 declare class Timer {
@@ -1458,28 +1427,7 @@ declare const rrweb_record: typeof record;
 type rrweb_recordOptions<T> = recordOptions<T>;
 declare const rrweb_unpack: typeof unpack;
 declare namespace rrweb {
-  export {
-    rrweb_EventType as EventType,
-    rrweb_IncrementalSource as IncrementalSource,
-    rrweb_LogData as LogData,
-    rrweb_LogLevel as LogLevel,
-    rrweb_Logger as Logger,
-    rrweb_MouseInteractions as MouseInteractions,
-    rrweb_PLUGIN_NAME as PLUGIN_NAME,
-    rrweb_Replayer as Replayer,
-    rrweb_ReplayerEvents as ReplayerEvents,
-    rrweb_StringifyOptions as StringifyOptions,
-    rrweb_addCustomEvent as addCustomEvent,
-    rrweb_freezePage as freezePage,
-    rrweb_getRecordConsolePlugin as getRecordConsolePlugin,
-    rrweb_getReplayConsolePlugin as getReplayConsolePlugin,
-    _mirror as mirror,
-    rrweb_pack as pack,
-    rrweb_record as record,
-    rrweb_recordOptions as recordOptions,
-    rrweb_unpack as unpack,
-    utils_d as utils,
-  };
+  export { rrweb_EventType as EventType, rrweb_IncrementalSource as IncrementalSource, type rrweb_LogData as LogData, type rrweb_LogLevel as LogLevel, type rrweb_Logger as Logger, rrweb_MouseInteractions as MouseInteractions, rrweb_PLUGIN_NAME as PLUGIN_NAME, rrweb_Replayer as Replayer, rrweb_ReplayerEvents as ReplayerEvents, type rrweb_StringifyOptions as StringifyOptions, rrweb_addCustomEvent as addCustomEvent, rrweb_freezePage as freezePage, rrweb_getRecordConsolePlugin as getRecordConsolePlugin, rrweb_getReplayConsolePlugin as getReplayConsolePlugin, _mirror as mirror, rrweb_pack as pack, rrweb_record as record, type rrweb_recordOptions as recordOptions, rrweb_unpack as unpack, utils_d as utils };
 }
 
 interface XhrResponse {
@@ -1608,7 +1556,7 @@ declare class UpChunk {
      */
     private sendChunks;
 }
-declare const createUpload$1: typeof UpChunk.createUpload;
+declare function createUpload$1(options: UpChunkOptions): UpChunk;
 
 type _mux_upchunk_ChunkedStreamIterable = ChunkedStreamIterable;
 declare const _mux_upchunk_ChunkedStreamIterable: typeof ChunkedStreamIterable;
@@ -1619,15 +1567,7 @@ type _mux_upchunk_UpChunkOptions = UpChunkOptions;
 declare const _mux_upchunk_getChunkSizeError: typeof getChunkSizeError;
 declare const _mux_upchunk_isValidChunkSize: typeof isValidChunkSize;
 declare namespace _mux_upchunk {
-  export {
-    _mux_upchunk_ChunkedStreamIterable as ChunkedStreamIterable,
-    _mux_upchunk_ChunkedStreamIterableOptions as ChunkedStreamIterableOptions,
-    _mux_upchunk_UpChunk as UpChunk,
-    _mux_upchunk_UpChunkOptions as UpChunkOptions,
-    createUpload$1 as createUpload,
-    _mux_upchunk_getChunkSizeError as getChunkSizeError,
-    _mux_upchunk_isValidChunkSize as isValidChunkSize,
-  };
+  export { _mux_upchunk_ChunkedStreamIterable as ChunkedStreamIterable, type _mux_upchunk_ChunkedStreamIterableOptions as ChunkedStreamIterableOptions, _mux_upchunk_UpChunk as UpChunk, type _mux_upchunk_UpChunkOptions as UpChunkOptions, createUpload$1 as createUpload, _mux_upchunk_getChunkSizeError as getChunkSizeError, _mux_upchunk_isValidChunkSize as isValidChunkSize };
 }
 
 declare enum NOTIFICATION_TYPES {
@@ -1876,74 +1816,6 @@ declare class Emitter<Events extends EventMap> {
     rawListeners<EventName extends keyof Events>(eventName: EventName): Array<Listener<Events[EventName]>>;
 }
 
-declare enum DismissReason {
-    Closed = "close.click",
-    Complete = "survey.completed",
-    PageChange = "page.change",
-    API = "api",
-    Override = "override"
-}
-declare enum SprigEvent {
-    ReplayCapture = "replay.capture",
-    SDKReady = "sdk.ready",
-    SurveyAppeared = "survey.appeared",
-    SurveyClosed = "survey.closed",
-    SurveyDimensions = "survey.dimensions",
-    SurveyFadingOut = "survey.fadingOut",
-    SurveyHeight = "survey.height",
-    SurveyPresented = "survey.presented",
-    SurveyLifeCycle = "survey.lifeCycle",
-    SurveyWidth = "survey.width",
-    SurveyWillClose = "survey.willClose",
-    SurveyWillPresent = "survey.will.present",
-    CloseSurveyOnOverlayClick = "close.survey.overlayClick",
-    VisitorIDUpdated = "visitor.id.updated",
-    QuestionAnswered = "question.answered"
-}
-declare enum SprigEventData {
-    SurveyId = "survey.id"
-}
-declare const EVENTS: {
-    SDK_READY: SprigEvent;
-    SURVEY_APPEARED: SprigEvent;
-    SURVEY_CLOSED: SprigEvent;
-    SURVEY_DIMENSIONS: SprigEvent;
-    SURVEY_FADING_OUT: SprigEvent;
-    SURVEY_HEIGHT: SprigEvent;
-    SURVEY_PRESENTED: SprigEvent;
-    SURVEY_LIFE_CYCLE: SprigEvent;
-    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: {
-        DISMISS_REASONS: {
-            API: DismissReason;
-            CLOSED: DismissReason;
-            COMPLETE: DismissReason;
-            PAGE_CHANGE: DismissReason;
-            OVERRIDE: DismissReason;
-        };
-        SURVEY_ID: SprigEventData;
-    };
-};
-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"
-}
-
 declare const enum MediaType {
     Video = "video",
     Audio = "audio",
@@ -1986,34 +1858,6 @@ 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;
@@ -2345,12 +2189,132 @@ interface VideoVoiceCard extends BaseCard {
 }
 type Card = TextUrlPromptCard | ConsentLegalCard | RecordedTaskCard | LikertCard | OpenTextCard | MatrixCard | MultipleChoiceSingleSelectCard | MultipleChoiceMultiSelectCard | NPSCard | VideoVoiceCard;
 
+type MatchType = "exactly" | "legacy";
+interface InteractiveEvent {
+    id: number;
+    matchType: MatchType;
+    name: string;
+    pattern: string;
+    properties: {
+        innerText: string;
+        selector?: string;
+        type?: "click";
+    };
+}
+interface PageUrlEvent {
+    id: number;
+    matchType: MatchType | "contains" | "notContains" | "regex" | "startsWith";
+    pattern: string;
+}
+
+declare enum DismissReason {
+    Closed = "close.click",
+    Complete = "survey.completed",
+    PageChange = "page.change",
+    API = "api",
+    Override = "override"
+}
+declare enum SprigEvent {
+    ReplayCapture = "replay.capture",
+    SDKReady = "sdk.ready",
+    SurveyAppeared = "survey.appeared",
+    SurveyClosed = "survey.closed",
+    SurveyDimensions = "survey.dimensions",
+    SurveyFadingOut = "survey.fadingOut",
+    SurveyHeight = "survey.height",
+    SurveyPresented = "survey.presented",
+    SurveyLifeCycle = "survey.lifeCycle",
+    SurveyWidth = "survey.width",
+    SurveyWillClose = "survey.willClose",
+    SurveyWillPresent = "survey.will.present",
+    CloseSurveyOnOverlayClick = "close.survey.overlayClick",
+    VisitorIDUpdated = "visitor.id.updated",
+    QuestionAnswered = "question.answered"
+}
+declare enum SprigEventData {
+    SurveyId = "survey.id"
+}
+declare const EVENTS: {
+    SDK_READY: SprigEvent;
+    SURVEY_APPEARED: SprigEvent;
+    SURVEY_CLOSED: SprigEvent;
+    SURVEY_DIMENSIONS: SprigEvent;
+    SURVEY_FADING_OUT: SprigEvent;
+    SURVEY_HEIGHT: SprigEvent;
+    SURVEY_PRESENTED: SprigEvent;
+    SURVEY_LIFE_CYCLE: SprigEvent;
+    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: {
+        DISMISS_REASONS: {
+            API: DismissReason;
+            CLOSED: DismissReason;
+            COMPLETE: DismissReason;
+            PAGE_CHANGE: DismissReason;
+            OVERRIDE: DismissReason;
+        };
+        SURVEY_ID: SprigEventData;
+    };
+};
+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;
 }
 
+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 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;
+};
+
 interface MobileReplayConfig {
     maxMobileReplayDurationSeconds?: number;
     mobileReplaySettings?: {
@@ -2491,24 +2455,6 @@ type SprigEventMap = {
 declare const eventEmitter: Emitter<SprigEventMap>;
 type SprigEventEmitter = typeof eventEmitter;
 
-type MatchType = "exactly" | "legacy";
-interface InteractiveEvent {
-    id: number;
-    matchType: MatchType;
-    name: string;
-    pattern: string;
-    properties: {
-        innerText: string;
-        selector?: string;
-        type?: "click";
-    };
-}
-interface PageUrlEvent {
-    id: number;
-    matchType: MatchType | "contains" | "notContains" | "regex" | "startsWith";
-    pattern: string;
-}
-
 declare const enum FramePosition {
     BottomLeft = "bottomLeft",
     BottomRight = "bottomRight",
@@ -2598,7 +2544,7 @@ interface Config extends MobileReplayConfig {
         /** @example "2.18.0" */
         "x-ul-sdk-version": string;
         /** For web-bundled sdk */
-        "x-ul-bundled-sdk-version"?: string;
+        "x-ul-package-version"?: string;
         [HttpHeader.UserID]?: string;
         [HttpHeader.VisitorID]?: UUID;
     };
@@ -2651,39 +2597,33 @@ interface Config extends MobileReplayConfig {
     };
 }
 
-declare enum ReplayDurationType {
-    After = "after",
-    Before = "before",
-    BeforeAndAfter = "beforeAndAfter"
+interface Experiment {
+    id: string;
+    variation?: string;
 }
-declare enum ReplayEventType {
-    Click = "Sprig_Click",
-    Event = "Sprig_TrackEvent",
-    PageView = "Sprig_PageView",
-    SurveyShown = "Sprig_ShowSurvey",
-    SurveySubmitted = "Sprig_SubmitSurvey",
-    Noop = "Sprig_Noop"
+
+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"
 }
-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 {
@@ -2780,7 +2720,7 @@ declare namespace sprigConfig {
     importLaunchDarklyData: (data: Record<string, number | undefined>) => void;
     integrateOptimizely: (
       strData: string | { experiments: Experiment[] },
-      isOverride?: boolean
+      isOverride?: boolean,
     ) => void;
     integrateOptimizelyClient: (client: Client) => void;
     logoutUser: () => void;
@@ -2790,22 +2730,22 @@ declare namespace sprigConfig {
     removeAttributes: (attributes: SprigAttributes) => IdentifyResult;
     removeListener: (
       event: SprigEvent,
-      listener: SprigListener
+      listener: SprigListener,
     ) => Promise<void>;
     removeSurveyListener: (listener: SprigListener) => Promise<void>;
     reviewSurvey: (surveyId: number) => void;
     setAttribute: (attribute: string, value: string | number) => IdentifyResult;
     setAttributes: (attributes?: SprigAttributes) => IdentifyResult;
     setPartnerAnonymousId: (
-      partnerAnonymousId: string
+      partnerAnonymousId: string,
     ) => Promise<{ success: boolean; message?: string }>;
     setVisitorAttribute: (
       attribute: string,
-      value: string | number
+      value: string | number,
     ) => IdentifyResult;
     setWindowDimensions: (
       width: number | string,
-      height: number | string
+      height: number | string,
     ) => void;
     setEmail: (email: string) => IdentifyResult;
     setPreviewKey: (previewKey: string) => void;
@@ -2817,12 +2757,12 @@ declare namespace sprigConfig {
       eventName: string,
       properties?: TrackPayload["properties"],
       metadata?: SprigMetadata,
-      showSurveyCallback?: (surveyId?: number) => Promise<boolean>
+      showSurveyCallback?: (surveyId?: number) => Promise<boolean>,
     ) => IdentifyResult;
     trackPageView: (
       url: string,
       properties?: SprigProperties,
-      showSurveyCallback?: (surveyId?: number) => Promise<boolean>
+      showSurveyCallback?: (surveyId?: number) => Promise<boolean>,
     ) => void;
     unmute: () => void;
   }
@@ -2874,16 +2814,19 @@ type ArgumentType<T> = T extends (arg1: infer U, ...args: unknown[]) => unknown
   ? U
   : unknown;
 type PublicOf<T> = { [K in keyof T]: T[K] };
-type createUpload = typeof _mux_upchunk["createUpload"];
-type rrwebRecord = typeof rrweb["record"];
-type rrwebCustomEvent = typeof rrweb["record"]["addCustomEvent"];
+type createUpload = (typeof _mux_upchunk)["createUpload"];
+type rrwebRecord = (typeof rrweb)["record"];
+type rrwebCustomEvent = (typeof rrweb)["record"]["addCustomEvent"];
 declare global {
   interface Window {
     __cfg: Config;
     attachEvent?: typeof window.addEventListener;
+    Backbone: {
+      history: typeof window.history;
+    };
     Intercom: { ul_wasVisible?: boolean } & ((
       method: string,
-      data: unknown
+      data: unknown,
     ) => void);
     optimizely?: optimizely.Optimizely;
     optimizelyDatafile?: object;
@@ -2901,7 +2844,7 @@ declare global {
         ...args: ArgumentTypes<rrwebCustomEvent>
       ) => PublicOf<ReturnType<rrwebCustomEvent>>;
     } & ((
-      arg: Omit<ArgumentType<rrwebRecord>, "hooks">
+      arg: Omit<ArgumentType<rrwebRecord>, "hooks">,
     ) => PublicOf<ReturnType<rrwebRecord>>);
     sprigAPI?: object;
   }
@@ -3072,4 +3015,4 @@ declare const _default: {
     configure: (config: NpmConfig) => sprigConfig.WindowSprig;
 };
 
-export { DismissReason, SprigAPI, SprigEvent, WindowSprig$1 as WindowSprig, _default as default, sprig };
+export { DismissReason, SprigAPI, SprigEvent, type WindowSprig$1 as WindowSprig, _default as default, sprig };