@sprig-technologies/sprig-browser 2.28.1 → 2.30.0

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,6 +1456,7 @@ interface XhrHeaders {
   [key: string]: string;
 }
 
+declare type XhrResponseLike = Partial<XhrResponse> & Pick<XhrResponse, 'statusCode'>;
 declare const isValidChunkSize: (chunkSize: any, { minChunkSize, maxChunkSize, }?: {
     minChunkSize?: number | undefined;
     maxChunkSize?: number | undefined;
@@ -1455,23 +1470,46 @@ declare type ChunkedStreamIterableOptions = {
     minChunkSize?: number;
     maxChunkSize?: number;
 };
-declare class ChunkedStreamIterable implements AsyncIterable<Blob> {
+interface ChunkedIterable extends AsyncIterable<Blob> {
+    chunkSize: number;
+    readonly chunkByteSize: number;
+    readonly minChunkSize: number;
+    readonly maxChunkSize: number;
+    readonly error: Error | undefined;
+}
+declare class ChunkedStreamIterable implements ChunkedIterable {
     protected readableStream: ReadableStream<Uint8Array | Blob>;
     protected _chunkSize: number | undefined;
     protected defaultChunkSize: number;
+    protected _error: Error | undefined;
     readonly minChunkSize: number;
     readonly maxChunkSize: number;
     constructor(readableStream: ReadableStream<Uint8Array | Blob>, options?: ChunkedStreamIterableOptions);
     get chunkSize(): number;
     set chunkSize(value: number);
     get chunkByteSize(): number;
+    get error(): Error | undefined;
+    [Symbol.asyncIterator](): AsyncIterator<Blob>;
+}
+declare class ChunkedFileIterable implements ChunkedIterable {
+    protected file: File;
+    protected _chunkSize: number | undefined;
+    protected defaultChunkSize: number;
+    protected _error: Error | undefined;
+    readonly minChunkSize: number;
+    readonly maxChunkSize: number;
+    constructor(file: File, options?: ChunkedStreamIterableOptions);
+    get chunkSize(): number;
+    set chunkSize(value: number);
+    get chunkByteSize(): number;
+    get error(): Error | undefined;
     [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 const isIncompleteChunkUploadNeedingRetry: (res: XhrResponseLike | undefined, _options?: any) => res is XhrResponseLike;
 declare type EventName = 'attempt' | 'attemptFailure' | 'chunkSuccess' | 'error' | 'offline' | 'online' | 'progress' | 'success';
 declare type AllowedMethods = 'PUT' | 'POST' | 'PATCH';
 interface UpChunkOptions {
@@ -1487,6 +1525,7 @@ interface UpChunkOptions {
     dynamicChunkSize?: boolean;
     maxChunkSize?: number;
     minChunkSize?: number;
+    useLargeFileWorkaround?: boolean;
 }
 declare class UpChunk {
     static createUpload(options: UpChunkOptions): UpChunk;
@@ -1498,15 +1537,15 @@ declare class UpChunk {
     delayBeforeAttempt: number;
     retryCodes: number[];
     dynamicChunkSize: boolean;
-    protected chunkedStreamIterable: ChunkedStreamIterable;
-    protected chunkedStreamIterator: AsyncIterator<Blob, any, undefined>;
+    protected chunkedIterable: ChunkedIterable;
+    protected chunkedIterator: AsyncIterator<Blob, any, undefined>;
     protected pendingChunk?: Blob;
     private chunkCount;
     private maxFileBytes;
     private endpointValue;
     private totalChunks;
     private attemptCount;
-    private offline;
+    private _offline;
     private _paused;
     private success;
     private currentXhr?;
@@ -1532,10 +1571,12 @@ declare class UpChunk {
      * Unsubscribe to an event
      */
     off(eventName: EventName, fn: (event: CustomEvent) => void): void;
+    get offline(): boolean;
     get paused(): boolean;
     abort(): void;
     pause(): void;
     resume(): void;
+    get successfulPercentage(): number;
     /**
      * Dispatch an event
      */
@@ -1562,6 +1603,9 @@ declare class UpChunk {
 }
 declare function createUpload$1(options: UpChunkOptions): UpChunk;
 
+type _mux_upchunk_ChunkedFileIterable = ChunkedFileIterable;
+declare const _mux_upchunk_ChunkedFileIterable: typeof ChunkedFileIterable;
+type _mux_upchunk_ChunkedIterable = ChunkedIterable;
 type _mux_upchunk_ChunkedStreamIterable = ChunkedStreamIterable;
 declare const _mux_upchunk_ChunkedStreamIterable: typeof ChunkedStreamIterable;
 type _mux_upchunk_ChunkedStreamIterableOptions = ChunkedStreamIterableOptions;
@@ -1572,7 +1616,7 @@ 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 };
+  export { _mux_upchunk_ChunkedFileIterable as ChunkedFileIterable, type _mux_upchunk_ChunkedIterable as ChunkedIterable, _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 enum NOTIFICATION_TYPES {
@@ -2442,7 +2486,7 @@ interface Config extends MobileReplayConfig {
         };
     };
     customMetadata?: Record<string, unknown>;
-    customStyles: string;
+    customStyles?: string;
     dismissOnPageChange: boolean;
     forceBrandedLogo?: boolean;
     endCard?: {
@@ -2508,7 +2552,6 @@ interface Config extends MobileReplayConfig {
     path?: string;
     platform?: Platform;
     previewKey?: string | null;
-    previewLanguage?: string;
     productConfig?: AppProductConfig;
     replayNonce?: string;
     replaySettings?: object;
@@ -2522,6 +2565,7 @@ interface Config extends MobileReplayConfig {
     studyType?: StudyType;
     surveyId: number;
     tabTitle: string;
+    trackPageViewUrl?: string;
     ulEvents: typeof SprigEvent;
     UpChunk: Window["UpChunk"];
     useDesktopPrototype?: boolean;
@@ -2646,6 +2690,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 +2749,7 @@ declare namespace sprigConfig {
       url: string,
       properties?: SprigProperties,
       showSurveyCallback?: (surveyId?: number) => Promise<boolean>,
+      calledFromApi?: boolean,
     ) => void;
     unmute: () => void;
   }
@@ -2718,7 +2764,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,6 +2779,7 @@ declare namespace sprigConfig {
       email?: string | null;
       envId: string;
       error?: Error;
+      feedbackCustomStyles?: string;
       frameId: string;
       loaded: boolean;
       locale?: string;
@@ -2793,7 +2843,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,j as r,h as p}from"./index-DPcbQptf.js";export{s as DismissReason,a as SprigAPI,i as SprigEvent,r as default,p as sprig};
+import{D as s,g as a,S as i,j as r,h as p}from"./index-Del4rEas.js";export{s as DismissReason,a as SprigAPI,i as SprigEvent,r as default,p as sprig};