@sprig-technologies/sprig-browser 2.24.3 → 2.24.5

package/dist/index.d.ts

@@ -374,7 +374,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 +398,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 +514,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 +659,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 +667,7 @@ interface RecordedTaskResponseType {
     value: RecordedTaskResponseValueType;
 }
 
-declare type SprigEventMap = {
+type SprigEventMap = {
     [InternalEventName.CurrentQuestion]: [
         {
             [InternalEventData.QuestionId]: number;
@@ -774,9 +774,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;
@@ -914,7 +914,6 @@ interface Config {
     surveyId: number;
     tabTitle: string;
     ulEvents: typeof SprigEvent;
-    UpChunk: Window["UpChunk"];
     useDesktopPrototype?: boolean;
     useMobileStyling: boolean;
     userId: UUID | null;
@@ -937,7 +936,7 @@ interface Experiment {
     variation?: string;
 }
 
-declare type QueueItem = [string, ...unknown[]] | (() => void);
+type QueueItem = [string, ...unknown[]] | (() => void);
 declare class SprigQueue {
     paused: boolean;
     queue: QueueItem[];
@@ -994,44 +993,6 @@ 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
@@ -1106,6 +1067,11 @@ declare namespace sprigConfig {
       metadata?: SprigMetadata,
       showSurveyCallback?: (surveyId?: number) => Promise<boolean>
     ) => IdentifyResult;
+    trackPageView: (
+      url: string,
+      properties?: SprigProperties,
+      showSurveyCallback?: (surveyId?: number) => Promise<boolean>
+    ) => void;
     unmute: () => void;
   }
 
@@ -1142,7 +1108,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;
@@ -1164,7 +1130,6 @@ declare global {
     optimizely?: optimizely.Optimizely;
     optimizelyDatafile?: object;
     previewMode?: unknown;
-    UpChunk: upchunk.UpChunkModule;
     _Sprig?: sprigConfig.WindowSprig;
     Sprig: sprigConfig.WindowSprig;
     UserLeap: sprigConfig.WindowSprig;
@@ -1289,6 +1254,10 @@ declare class SprigAPI {
         metadata?: SprigMetadata;
         userId?: string;
     }): void;
+    /**
+     * Tracks a page view with the provided URL and additional event properties.
+     */
+    trackPageView(url: string, props?: SprigProperties, showSurveyCallback?: (surveyId?: number) => Promise<boolean>): void;
     /**
      * Apply a css string representing the customized styles
      */
@@ -1306,7 +1275,7 @@ declare class SprigAPI {
      */
     teardown(): void;
 }
-declare type NpmConfig = {
+type NpmConfig = {
     envId?: string;
     environmentId?: string;
     path?: string;
@@ -1319,7 +1288,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: {