@sprig-technologies/sprig-bundled 1.1.4 → 1.1.5

package/dist/index.d.ts

@@ -27,6 +27,7 @@ type elementNode = {
     childNodes: serializedNodeWithId[];
     isSVG?: true;
     needBlock?: boolean;
+    isCustom?: true;
 };
 type textNode = {
     type: NodeType.Text;
@@ -98,7 +99,7 @@ type DataURLOptions = Partial<{
     type: string;
     quality: number;
 }>;
-type MaskTextFn = (text: string) => string;
+type MaskTextFn = (text: string, element: HTMLElement | null) => string;
 type MaskInputFn = (text: string, element: HTMLElement) => string;
 
 declare class Mirror$1 implements IMirror<Node> {
@@ -185,7 +186,8 @@ declare enum IncrementalSource {
     Drag = 12,
     StyleDeclaration = 13,
     Selection = 14,
-    AdoptedStyleSheet = 15
+    AdoptedStyleSheet = 15,
+    CustomElement = 16
 }
 type mutationData = {
     source: IncrementalSource.Mutation;
@@ -228,7 +230,10 @@ type selectionData = {
 type adoptedStyleSheetData = {
     source: IncrementalSource.AdoptedStyleSheet;
 } & adoptedStyleSheetParam;
-type incrementalData = mutationData | mousemoveData | mouseInteractionData | scrollData | viewportResizeData | inputData | mediaInteractionData | styleSheetRuleData | canvasMutationData | fontData | selectionData | styleDeclarationData | adoptedStyleSheetData;
+type customElementData = {
+    source: IncrementalSource.CustomElement;
+} & customElementParam;
+type incrementalData = mutationData | mousemoveData | mouseInteractionData | scrollData | viewportResizeData | inputData | mediaInteractionData | styleSheetRuleData | canvasMutationData | fontData | selectionData | styleDeclarationData | adoptedStyleSheetData | customElementData;
 type event = domContentLoadedEvent | loadedEvent | fullSnapshotEvent | incrementalSnapshotEvent | metaEvent | customEvent | pluginEvent;
 type eventWithTime = event & {
     timestamp: number;
@@ -280,6 +285,7 @@ type hooksParam = {
     canvasMutation?: canvasMutationCallback;
     font?: fontCallback;
     selection?: selectionCallback;
+    customElement?: customElementCallback;
 };
 type textMutation = {
     id: number;
@@ -347,8 +353,8 @@ declare enum CanvasContext {
 type mouseInteractionParam = {
     type: MouseInteractions;
     id: number;
-    x: number;
-    y: number;
+    x?: number;
+    y?: number;
     pointerType?: PointerTypes;
 };
 type mouseInteractionCallBack = (d: mouseInteractionParam) => void;
@@ -443,6 +449,7 @@ type mediaInteractionParam = {
     currentTime?: number;
     volume?: number;
     muted?: boolean;
+    loop?: boolean;
     playbackRate?: number;
 };
 type mediaInteractionCallback = (p: mediaInteractionParam) => void;
@@ -462,6 +469,12 @@ type selectionParam = {
     ranges: Array<SelectionRange>;
 };
 type selectionCallback = (p: selectionParam) => void;
+type customElementParam = {
+    define?: {
+        name: string;
+    };
+};
+type customElementCallback = (c: customElementParam) => void;
 type DeprecatedMirror = {
     map: {
         [key: number]: INode;
@@ -822,6 +835,7 @@ declare const RRMediaElement_base: {
         paused?: boolean | undefined;
         muted?: boolean | undefined;
         playbackRate?: number | undefined;
+        loop?: boolean | undefined;
         attachShadow(_init: ShadowRootInit): IRRElement;
         play(): void;
         pause(): void;
@@ -1442,14 +1456,6 @@ interface XhrHeaders {
   [key: string]: string;
 }
 
-declare const isValidChunkSize: (chunkSize: any, { minChunkSize, maxChunkSize, }?: {
-    minChunkSize?: number | undefined;
-    maxChunkSize?: number | undefined;
-}) => chunkSize is number | null | undefined;
-declare const getChunkSizeError: (chunkSize: any, { minChunkSize, maxChunkSize, }?: {
-    minChunkSize?: number | undefined;
-    maxChunkSize?: number | undefined;
-}) => TypeError;
 declare type ChunkedStreamIterableOptions = {
     defaultChunkSize?: number;
     minChunkSize?: number;
@@ -1467,11 +1473,6 @@ declare class ChunkedStreamIterable implements AsyncIterable<Blob> {
     get chunkByteSize(): number;
     [Symbol.asyncIterator](): AsyncIterator<Blob>;
 }
-/**
- * Checks if an upload chunk was partially received (HTTP 308) and needs a retry.
- * Validates against the 'Range' header to ensure the full chunk was processed.
- */
-declare const isIncompleteChunkUploadNeedingRetry: (res: XhrResponse | undefined, _options?: any) => res is XhrResponse;
 declare type EventName = 'attempt' | 'attemptFailure' | 'chunkSuccess' | 'error' | 'offline' | 'online' | 'progress' | 'success';
 declare type AllowedMethods = 'PUT' | 'POST' | 'PATCH';
 interface UpChunkOptions {
@@ -1560,20 +1561,7 @@ declare class UpChunk {
      */
     private sendChunks;
 }
-declare function createUpload$1(options: UpChunkOptions): UpChunk;
-
-type _mux_upchunk_ChunkedStreamIterable = ChunkedStreamIterable;
-declare const _mux_upchunk_ChunkedStreamIterable: typeof ChunkedStreamIterable;
-type _mux_upchunk_ChunkedStreamIterableOptions = ChunkedStreamIterableOptions;
-type _mux_upchunk_UpChunk = UpChunk;
-declare const _mux_upchunk_UpChunk: typeof UpChunk;
-type _mux_upchunk_UpChunkOptions = UpChunkOptions;
-declare const _mux_upchunk_getChunkSizeError: typeof getChunkSizeError;
-declare const _mux_upchunk_isIncompleteChunkUploadNeedingRetry: typeof isIncompleteChunkUploadNeedingRetry;
-declare const _mux_upchunk_isValidChunkSize: typeof isValidChunkSize;
-declare namespace _mux_upchunk {
-  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_isIncompleteChunkUploadNeedingRetry as isIncompleteChunkUploadNeedingRetry, _mux_upchunk_isValidChunkSize as isValidChunkSize };
-}
+declare const createUpload: typeof UpChunk.createUpload;
 
 declare enum NOTIFICATION_TYPES {
     ACTIVATE = "ACTIVATE:experiment, user_id,attributes, variation, event",
@@ -2151,11 +2139,11 @@ interface PageUrlEvent {
 }
 
 declare enum DismissReason {
-    Closed = "close.click",
-    Complete = "survey.completed",
-    FeedbackClosed = "feedback.closed",
-    PageChange = "page.change",
-    API = "api",
+    Closed = "close.click",// user clicked the close button
+    Complete = "survey.completed",// user answered all questions
+    FeedbackClosed = "feedback.closed",// user either clicked on feedback button or close button
+    PageChange = "page.change",// productConfig.dismissOnPageChange == true and we detected a page change (excludes hash/query param changes)
+    API = "api",// JS called Sprig('dismissActiveSurvey')
     Override = "override"
 }
 type StudyType = "feedbackButton" | "inProductSurvey";
@@ -2206,7 +2194,7 @@ declare const EVENTS: {
     };
 };
 
-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 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" | "sdk_mutations_nodes_added" | "sdk_mutations_nodes_removed" | "sdk_mutations_attributes_changed" | "sdk_mutations_character_data" | "sdk_dom_nodes_count" | "sdk_page_html_characters";
 type ThresholdType = "max" | "min";
 interface MetricThreshold {
     metric: Metric;
@@ -2214,34 +2202,15 @@ interface MetricThreshold {
     value: number;
 }
 
-type ReplayDurationType = "after" | "before" | "beforeAndAfter";
-type EventDigest = {
-    timestamp: number;
-    type: "Sprig_Click";
-} | {
-    timestamp: number;
-    name: string;
-    type: "Sprig_TrackEvent";
-} | {
-    timestamp: number;
-    type: "Sprig_PageView";
-    url: string;
-} | {
-    timestamp: number;
-    surveyId: string;
-    type: "Sprig_ShowSurvey";
-} | {
-    timestamp: number;
-    surveyId: string;
-    type: "Sprig_SubmitSurvey";
-};
-
 interface RecordedTaskResponseType {
     questionId: number;
     type: CardType;
     value: RecordedTaskResponseValueType;
 }
 
+type SurveyState = "ready" | "no survey";
+type ReplayDurationType = "after" | "before" | "beforeAndAfter";
+
 interface MobileReplayConfig {
     mobileMetricsReportingEnabled?: boolean;
     metricsReportingInterval?: number;
@@ -2442,7 +2411,7 @@ interface Config extends MobileReplayConfig {
         };
     };
     customMetadata?: Record<string, unknown>;
-    customStyles: string;
+    customStyles?: string;
     dismissOnPageChange: boolean;
     forceBrandedLogo?: boolean;
     endCard?: {
@@ -2469,6 +2438,7 @@ interface Config extends MobileReplayConfig {
         Authorization?: string;
         "Content-Type"?: string;
         "userleap-platform": Platform | "ios" | "android" | "video_recorder";
+        "sprig-modules"?: string;
         /** @example "SJcVfq-7QQ" */
         "x-ul-environment-id"?: string;
         "x-ul-installation-method": InstallationMethod;
@@ -2508,7 +2478,7 @@ interface Config extends MobileReplayConfig {
     path?: string;
     platform?: Platform;
     previewKey?: string | null;
-    previewLanguage?: string;
+    previewMode?: boolean;
     productConfig?: AppProductConfig;
     replayNonce?: string;
     replaySettings?: object;
@@ -2522,8 +2492,10 @@ interface Config extends MobileReplayConfig {
     studyType?: StudyType;
     surveyId: number;
     tabTitle: string;
+    trackPageViewUrl?: string;
     ulEvents: typeof SprigEvent;
     UpChunk: Window["UpChunk"];
+    upchunkLibraryURL?: string;
     useDesktopPrototype?: boolean;
     useMobileStyling: boolean;
     userId: UUID | null;
@@ -2559,7 +2531,26 @@ declare class SprigQueue {
     empty(): void;
 }
 
-type SurveyState = "ready" | "no survey";
+type EventDigest = {
+    timestamp: number;
+    type: "Sprig_Click";
+} | {
+    timestamp: number;
+    name: string;
+    type: "Sprig_TrackEvent";
+} | {
+    timestamp: number;
+    type: "Sprig_PageView";
+    url: string;
+} | {
+    timestamp: number;
+    surveyId: string;
+    type: "Sprig_ShowSurvey";
+} | {
+    timestamp: number;
+    surveyId: string;
+    type: "Sprig_SubmitSurvey";
+};
 
 declare namespace optimizely {
   interface Optimizely {
@@ -2646,6 +2637,7 @@ declare namespace sprigConfig {
     // external apis
     addListener: (event: SprigEvent, listener: SprigListener) => Promise<void>;
     addSurveyListener: (listener: SprigListener) => Promise<void>;
+    applyFeedbackStyles: (styles: { button?: string; view?: string }) => void;
     applyStyles: (styleString: string) => void;
     dismissActiveSurvey: (reason?: DismissReason) => void;
     displaySurvey: (surveyId: number) => IdentifyResult;
@@ -2704,6 +2696,7 @@ declare namespace sprigConfig {
       url: string,
       properties?: SprigProperties,
       showSurveyCallback?: (surveyId?: number) => Promise<boolean>,
+      calledFromApi?: boolean,
     ) => void;
     unmute: () => void;
   }
@@ -2718,7 +2711,10 @@ declare namespace sprigConfig {
     SprigAPIActions &
     SprigCommands & {
       _API_URL: string;
-      _config: Config;
+      _config: Config & {
+        desktopDisplay?: string;
+        previewLanguage?: string;
+      };
       _gtm: unknown; // TODO: determine if boolean?
       _queue: SprigQueue;
       _segment: unknown; // TODO: determine if boolean?
@@ -2730,7 +2726,9 @@ declare namespace sprigConfig {
       email?: string | null;
       envId: string;
       error?: Error;
+      feedbackCustomStyles?: string;
       frameId: string;
+      isMobileSDK?: boolean;
       loaded: boolean;
       locale?: string;
       maxHeight?: number | string;
@@ -2738,10 +2736,12 @@ declare namespace sprigConfig {
       mobileHeadersJSON?: string;
       nonce?: string;
       partnerAnonymousId: string | null;
+      replayLibraryURL?: string;
       replayNonce?: string;
-      reportError: (name: string, err: Error, extraInfo?: object) => void;
+      reportError: (name: string, err: Error, extraInfo?: object, bodyInfo?: object) => void;
       sampleRate?: number;
       token: string | null;
+      upchunkLibraryURL?: string;
       UPDATES: typeof EVENTS;
       viewSDKURL?: string;
       windowDimensions?: {
@@ -2755,9 +2755,9 @@ 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 rrwebFullSnapshot = (typeof rrweb)["record"]["takeFullSnapshot"];
 declare global {
   interface Window {
     __cfg: Config;
@@ -2773,9 +2773,7 @@ declare global {
     optimizelyDatafile?: object;
     previewMode?: unknown;
     UpChunk: {
-      createUpload: (
-        ...args: ArgumentTypes<createUpload>
-      ) => PublicOf<ReturnType<createUpload>>;
+      createUpload: typeof createUpload;
     };
     _Sprig?: sprigConfig.WindowSprig;
     Sprig: sprigConfig.WindowSprig;
@@ -2784,6 +2782,9 @@ declare global {
       addCustomEvent: (
         ...args: ArgumentTypes<rrwebCustomEvent>
       ) => PublicOf<ReturnType<rrwebCustomEvent>>;
+      takeFullSnapshot: (
+        ...args: ArgumentTypes<rrwebFullSnapshot>
+      ) => PublicOf<ReturnType<rrwebFullSnapshot>>;
     } & ((
       arg: Omit<ArgumentType<rrwebRecord>, "hooks">,
     ) => PublicOf<ReturnType<rrwebRecord>>);
@@ -2793,7 +2794,13 @@ declare global {
   type WindowSprig = sprigConfig.WindowSprig;
   type SprigAttributes = Record<string, boolean | number | string>;
   type SprigListener = Listener<unknown[]>;
-  type SprigMetadata = Record<string, unknown>;
+  type SprigMetadata = {
+    url?: string;
+    trackPageView?: boolean;
+    optimizelyExperiments?: object;
+    launchDarklyFlags?: object;
+    eventProperties?: SprigProperties;
+  };
   type SprigProperties = Record<string, unknown>;
   type SprigAPIActions = sprigConfig.SprigAPIActions;
   type TrackPayload = sprigConfig.TrackPayload;

package/dist/index.js

@@ -1 +1 @@
-import{D as s,g as a,S as i,h as r}from"./index-Ce9gtwb7.js";export{s as DismissReason,a as SprigAPI,i as SprigEvent,r as sprig};
+import{D as s,h as a,S as i,j as r}from"./index-Cr-P2Ow4.js";export{s as DismissReason,a as SprigAPI,i as SprigEvent,r as sprig};