@sprig-technologies/sprig-browser 2.21.4 → 2.21.6

package/dist/index.d.ts

@@ -1,4 +1,75 @@
-import { StrictEventEmitter } from 'strict-event-emitter';
+declare type EventMap = {
+    [eventName: string]: Array<unknown>;
+};
+declare type InternalEventNames = 'newListener' | 'removeListener';
+declare type InternalListener<Events extends EventMap> = Listener<[
+    eventName: keyof Events,
+    listener: Listener<Array<unknown>>
+]>;
+declare type Listener<Data extends Array<unknown>> = (...data: Data) => void;
+/**
+ * Node.js-compatible implementation of `EventEmitter`.
+ *
+ * @example
+ * const emitter = new Emitter<{ hello: [string] }>()
+ * emitter.on('hello', (name) => console.log(name))
+ * emitter.emit('hello', 'John')
+ */
+declare class Emitter<Events extends EventMap> {
+    private events;
+    private maxListeners;
+    private hasWarnedAboutPotentialMemoryLeak;
+    static defaultMaxListeners: number;
+    static listenerCount<Events extends EventMap>(emitter: Emitter<EventMap>, eventName: keyof Events): number;
+    constructor();
+    private _emitInternalEvent;
+    private _getListeners;
+    private _removeListener;
+    private _wrapOnceListener;
+    setMaxListeners(maxListeners: number): this;
+    /**
+     * Returns the current max listener value for the `Emitter` which is
+     * either set by `emitter.setMaxListeners(n)` or defaults to
+     * `Emitter.defaultMaxListeners`.
+     */
+    getMaxListeners(): number;
+    /**
+     * Returns an array listing the events for which the emitter has registered listeners.
+     * The values in the array will be strings or Symbols.
+     */
+    eventNames(): Array<keyof Events>;
+    /**
+     * Synchronously calls each of the listeners registered for the event named `eventName`,
+     * in the order they were registered, passing the supplied arguments to each.
+     * Returns `true` if the event has listeners, `false` otherwise.
+     *
+     * @example
+     * const emitter = new Emitter<{ hello: [string] }>()
+     * emitter.emit('hello', 'John')
+     */
+    emit<EventName extends keyof Events>(eventName: EventName, ...data: Events[EventName]): boolean;
+    addListener(eventName: InternalEventNames, listener: InternalListener<Events>): this;
+    addListener<EventName extends keyof Events>(eventName: EventName, listener: Listener<Events[EventName]>): this;
+    on(eventName: InternalEventNames, listener: InternalListener<Events>): this;
+    on<EventName extends keyof Events>(eventName: EventName, listener: Listener<Events[EventName]>): this;
+    once(eventName: InternalEventNames, listener: InternalListener<Events>): this;
+    once<EventName extends keyof Events>(eventName: EventName, listener: Listener<Events[EventName]>): this;
+    prependListener(eventName: InternalEventNames, listener: InternalListener<Events>): this;
+    prependListener<EventName extends keyof Events>(eventName: EventName, listener: Listener<Events[EventName]>): this;
+    prependOnceListener(eventName: InternalEventNames, listener: InternalListener<Events>): this;
+    prependOnceListener<EventName extends keyof Events>(eventName: EventName, listener: Listener<Events[EventName]>): this;
+    removeListener(eventName: InternalEventNames, listener: InternalListener<Events>): this;
+    removeListener<EventName extends keyof Events>(eventName: EventName, listener: Listener<Events[EventName]>): this;
+    off(eventName: InternalEventNames, listener: InternalListener<Events>): this;
+    off<EventName extends keyof Events>(eventName: EventName, listener: Listener<Events[EventName]>): this;
+    removeAllListeners(eventName?: InternalEventNames): this;
+    removeAllListeners<EventName extends keyof Events>(eventName?: EventName): this;
+    listeners(eventName: InternalEventNames): Array<Listener<any>>;
+    listeners<EventName extends keyof Events>(eventName: EventName): Array<Listener<Events[EventName]>>;
+    listenerCount(eventName: InternalEventNames): number;
+    listenerCount<EventName extends keyof Events>(eventName: EventName): number;
+    rawListeners<EventName extends keyof Events>(eventName: EventName): Array<Listener<Events[EventName]>>;
+}
 
 declare enum DismissReason {
     Closed = "close.click",
@@ -82,6 +153,7 @@ declare const enum TaskStatus {
     Completed = "completed"
 }
 declare const enum SprigRecordingEventData {
+    ScreenPermissionRequested = "screen.permission.requested",
     PermissionDescriptors = "permission.descriptors",
     PermissionStatusCallback = "permission.status.callback",
     StreamReadyCallback = "stream.ready.callback",
@@ -232,6 +304,7 @@ interface ScreenTaskPage extends BaseTaskPage {
 }
 interface StartTaskPage extends BaseTaskPage {
     captionText?: string;
+    skipButtonText: string;
     taskDetail: string;
     type: RecordedTaskPageType.StartTask;
 }
@@ -400,81 +473,107 @@ interface RecordedTaskResponseType {
     value: RecordedTaskResponseValueType;
 }
 
-interface SprigEventMap {
-    [InternalEventName.CurrentQuestion]: (data: {
-        [InternalEventData.QuestionId]: number;
-        [InternalEventData.Props]: unknown;
-    }) => void;
-    [InternalEventName.RecordedTaskPermissionScreen]: () => void;
-    [InternalEventName.RecordedTaskStart]: () => void;
-    [InternalEventName.SurveyComplete]: () => void;
-    [InternalEventName.VerifyViewVersion]: (data: {
-        [InternalEventData.ViewVersion]: string;
-    }) => void;
-    [SprigEvent.CloseSurveyOnOverlayClick]: () => void;
-    [SprigEvent.SDKReady]: () => void;
-    [SprigEvent.SurveyAppeared]: () => void;
-    [SprigEvent.SurveyDimensions]: (data: {
-        contentFrameHeight: number;
-        contentFrameWidth: number;
-        name: string;
-    }) => void;
-    [SprigEvent.SurveyClosed]: (data: {
-        initiator?: unknown;
-        name: string;
-    }) => void;
-    [SprigEvent.SurveyFadingOut]: () => void;
-    [SprigEvent.SurveyHeight]: (data: {
-        name: string;
-        contentFrameHeight: number;
-    }) => void;
-    [SprigEvent.SurveyLifeCycle]: (data: {
+declare type SprigEventMap = {
+    [InternalEventName.CurrentQuestion]: [
+        {
+            [InternalEventData.QuestionId]: number;
+            [InternalEventData.Props]: unknown;
+        }
+    ];
+    [InternalEventName.RecordedTaskPermissionScreen]: [];
+    [InternalEventName.RecordedTaskStart]: [];
+    [InternalEventName.SurveyComplete]: [];
+    [InternalEventName.VerifyViewVersion]: [
+        {
+            [InternalEventData.ViewVersion]: string;
+        }
+    ];
+    [SprigEvent.CloseSurveyOnOverlayClick]: [];
+    [SprigEvent.SDKReady]: [];
+    [SprigEvent.SurveyAppeared]: [];
+    [SprigEvent.SurveyDimensions]: [
+        {
+            contentFrameHeight: number;
+            contentFrameWidth: number;
+            name: string;
+        }
+    ];
+    [SprigEvent.SurveyClosed]: [
+        {
+            initiator?: string;
+            name: string;
+        }
+    ];
+    [SprigEvent.SurveyFadingOut]: [];
+    [SprigEvent.SurveyHeight]: [
+        {
+            name: string;
+            contentFrameHeight: number;
+        }
+    ];
+    [SprigEvent.SurveyLifeCycle]: [{
         state: string;
-    }) => void;
-    [SprigEvent.SurveyPresented]: (data: {
-        name: string;
-    }) => void;
-    [SprigEvent.SurveyWillClose]: (data: {
-        initiator: DismissReason;
-        name?: string;
-    }) => void;
-    [SprigEvent.SurveyWillPresent]: (data: {
+    }];
+    [SprigEvent.SurveyPresented]: [{
         name: string;
-        "survey.id": number;
-    }) => void;
-    [SprigEvent.VisitorIDUpdated]: (data: {
+    }];
+    [SprigEvent.SurveyWillClose]: [
+        {
+            initiator: DismissReason;
+            name?: string;
+        }
+    ];
+    [SprigEvent.SurveyWillPresent]: [
+        {
+            name: string;
+            "survey.id": number;
+        }
+    ];
+    [SprigEvent.VisitorIDUpdated]: [{
         visitorId: string | null;
-    }) => void;
-    [SprigRecordingEvent.AvPermission]: (data: {
-        [SprigRecordingEventData.StreamCanceledCallback]: () => void;
-        [SprigRecordingEventData.StreamReadyCallback]: (avStream: MediaStream | null, captureStream?: MediaStream | null) => void;
-        [SprigRecordingEventData.PermissionDescriptors]: AvPermission[];
-    }) => void;
-    [SprigRecordingEvent.BeginRecording]: (data: {
-        [SprigRecordingEventData.RecordingMediaTypes]: MediaType[];
-        [SprigRecordingEventData.StartRecordingCallback]: (mediaRecordingUids: UUID[]) => void;
-    }) => void;
-    [SprigRecordingEvent.FinishTask]: (data: {
-        [SprigRecordingEventData.BeginCallback]: (mediaRecordingUid: UUID) => void;
-        [SprigRecordingEventData.CurrentIndex]: number;
-        [SprigRecordingEventData.PassthroughData]: PassthroughData;
-        [SprigRecordingEventData.ProgressCallback]: (mediaRecordingUid: UUID, data: {
-            detail: number;
-        }) => void;
-        [SprigRecordingEventData.TaskCompleteCallback]: (taskDurationMillisecond: number) => void;
-        [SprigRecordingEventData.TaskResponse]: RecordedTaskResponseType;
-        [SprigRecordingEventData.UploadCallback]: (mediaRecordingUid: UUID | null, successOrError: true | unknown) => void;
-    }) => void;
-    [SprigRecordingEvent.PermissionStatus]: (data: {
-        [SprigRecordingEventData.PermissionStatusCallback]: (avStream: MediaStream | undefined, hasVideoPermission: boolean, hasScreenPermission: boolean) => void;
-    }) => void;
-    [SprigRecordingEvent.ScreenPermission]: (data: {
-        [SprigRecordingEventData.StreamCanceledCallback]: () => void;
-        [SprigRecordingEventData.StreamReadyCallback]: (avStream: MediaStream | null, captureStream: MediaStream | null) => void;
-    }) => void;
-    [SprigRecordingEvent.StartTask]: () => void;
-}
-declare type SprigEventEmitter = StrictEventEmitter<SprigEventMap>;
+    }];
+    [SprigRecordingEvent.AvPermission]: [
+        {
+            [SprigRecordingEventData.StreamCanceledCallback]: () => void;
+            [SprigRecordingEventData.StreamReadyCallback]: (avStream: MediaStream | null, captureStream?: MediaStream | null) => void;
+            [SprigRecordingEventData.PermissionDescriptors]: AvPermission[];
+        }
+    ];
+    [SprigRecordingEvent.BeginRecording]: [
+        {
+            [SprigRecordingEventData.RecordingMediaTypes]: MediaType[];
+            [SprigRecordingEventData.StartRecordingCallback]: (mediaRecordingUids: UUID[]) => void;
+        }
+    ];
+    [SprigRecordingEvent.FinishTask]: [
+        {
+            [SprigRecordingEventData.BeginCallback]: (mediaRecordingUid: UUID) => void;
+            [SprigRecordingEventData.CurrentIndex]: number;
+            [SprigRecordingEventData.PassthroughData]: PassthroughData;
+            [SprigRecordingEventData.ProgressCallback]: (mediaRecordingUid: UUID, data: {
+                detail: number;
+            }) => void;
+            [SprigRecordingEventData.TaskCompleteCallback]: (taskDurationMillisecond: number) => void;
+            [SprigRecordingEventData.TaskResponse]: RecordedTaskResponseType;
+            [SprigRecordingEventData.UploadCallback]: (mediaRecordingUid: UUID | null, successOrError: true | unknown) => void;
+        }
+    ];
+    [SprigRecordingEvent.PermissionStatus]: [
+        {
+            [SprigRecordingEventData.PermissionStatusCallback]: (avStream: MediaStream | undefined, hasVideoPermission: boolean, hasScreenPermission: boolean) => void;
+        }
+    ];
+    [SprigRecordingEvent.ScreenPermission]: [
+        {
+            [SprigRecordingEventData.ScreenPermissionRequested]?: (data: boolean) => void;
+            [SprigRecordingEventData.StreamCanceledCallback]: () => void;
+            [SprigRecordingEventData.StreamReadyCallback]: (avStream: MediaStream | null, captureStream: MediaStream | null) => void;
+        }
+    ];
+    [SprigRecordingEvent.StartTask]: [];
+};
+declare const eventEmitter: Emitter<SprigEventMap>;
+declare type SprigEventEmitter = typeof eventEmitter;
 
 declare type MatchType = "exactly" | "legacy";
 interface InteractiveEvent {
@@ -733,6 +832,7 @@ declare namespace sprigConfig {
     eventName?: string;
     properties?: SprigProperties;
     userId?: string;
+    showSurveyCallback?: (surveyId: number) => Promise<boolean>;
   }
 
   interface SprigAPIActions {
@@ -741,12 +841,12 @@ declare namespace sprigConfig {
     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;
     }>;
-    dismissActiveSurvey: (reason?: DismissReason) => void;
     identifyAndSetAttributes: (payload: {
       anonymousId?: string;
       attributes?: SprigAttributes;
@@ -755,10 +855,10 @@ declare namespace sprigConfig {
     identifyAndTrack: (payload: TrackPayload) => IdentifyResult;
     integrateOptimizely: (strData: string) => void;
     logoutUser: () => void;
-    mute: () => unknown;
-    removeAttributes: (attributes: SprigAttributes) => IdentifyResult;
+    mute: () => void;
     previewSurvey: (surveyTemplateId: UUID) => void;
     removeAllListeners: () => Promise<void>;
+    removeAttributes: (attributes: SprigAttributes) => IdentifyResult;
     removeListener: (
       event: SprigEvent,
       listener: SprigListener
@@ -786,13 +886,21 @@ declare namespace sprigConfig {
     track: (
       eventName: string,
       properties?: TrackPayload["properties"],
-      metadata?: SprigMetadata
+      metadata?: SprigMetadata,
+      showSurveyCallback?: (surveyId: number) => Promise<boolean>
     ) => IdentifyResult;
-    unmute: (surveyId: number) => void;
+    unmute: () => void;
   }
 
+  type SprigCommand = keyof SprigAPIActions;
+  type SprigCommands = <C extends SprigCommand>(
+    command: C,
+    ...params: Parameters<SprigAPIActions[C]>
+  ) => ReturnType<SprigAPIActions[C]>;
+
   type WindowSprig = Config &
-    SprigAPIActions & {
+    SprigAPIActions &
+    SprigCommands & {
       _API_URL: string;
       _config: Config;
       _gtm: unknown; // TODO: determine if boolean?
@@ -823,60 +931,17 @@ declare namespace sprigConfig {
         height: number;
         width: number;
       };
-    } & ((name: "_previewSurvey", surveyTemplateId: string) => void) &
-    ((name: "_reviewSurvey", surveyId: number) => void) &
-    ((name: "addListener", event: string, listener: SprigListener) => void) &
-    ((name: "applyStyles", styles: string) => void) &
-    ((name: "dismissActiveSurvey", reason?: DismissReason) => void) &
-    ((name: "displaySurvey", surveyId: number) => void) &
-    ((
-      name: "identifyAndSetAttributes",
-      payload: {
-        anonymousID?: string;
-        attributes: SprigAttributes;
-        userID?: string;
-      }
-    ) => void) &
-    ((
-      name: "identifyAndTrack",
-      payload: {
-        anonymousId?: string;
-        eventName: string;
-        metadata?: SprigMetadata;
-        userId?: string;
-      }
-    ) => void) &
-    ((name: "logoutUser") => void) &
-    ((name: "mute") => void) &
-    ((name: "previewSurvey", surveyTemplateId: string) => void) &
-    ((name: "removeAllListeners") => void) &
-    ((name: "removeAttributes", attributes: SprigAttributes) => void) &
-    ((name: "removeListener", event: string, listener: SprigListener) => void) &
-    ((name: "reviewSurvey", surveyId: number) => void) &
-    ((name: "setAttribute", attribute: string, value: string) => void) &
-    ((name: "setAttributes", attributes: SprigAttributes) => void) &
-    ((name: "setPartnerAnonymousId", partnerAnonymousId: string) => void) &
-    ((name: "setUserId", userId: string) => void) &
-    ((
-      name: "setWindowDimensions",
-      width: number | string,
-      height: number | string
-    ) => void) &
-    ((name: "teardown") => void) &
-    ((
-      name: "track",
-      eventName: string,
-      properties?: SprigProperties,
-      metadata?: SprigMetadata
-    ) => void) &
-    ((name: "unmute") => void);
+    };
 }
 
 declare global {
   interface Window {
     __cfg: Config;
     attachEvent?: typeof window.addEventListener;
-    Intercom: Intercom_.IntercomStatic & { ul_wasVisible?: boolean };
+    Intercom: { ul_wasVisible?: boolean } & ((
+      method: string,
+      data: unknown
+    ) => void);
     optimizely?: optimizely.Optimizely;
     previewMode?: unknown;
     UpChunk: upchunk.UpChunkModule;
@@ -887,7 +952,7 @@ declare global {
 
   type WindowSprig = sprigConfig.WindowSprig;
   type SprigAttributes = Record<string, boolean | number | string>;
-  type SprigListener = (data: unknown) => void;
+  type SprigListener = Listener<unknown[]>;
   type SprigMetadata = Record<string, unknown>;
   type SprigProperties = Record<string, unknown>;
   type SprigAPIActions = sprigConfig.SprigAPIActions;
@@ -928,7 +993,6 @@ declare class SprigAPI {
     };
     /**
      * Triggers displaying specified survey. Does submit answers!
-     * @returns
      */
     displaySurvey(surveyId: number): void;
     /**
@@ -966,11 +1030,11 @@ declare class SprigAPI {
     /**
      * Add a listener for an event defined in ulEvents
      */
-    addListener(event: string, listener: SprigListener): void;
+    addListener(event: SprigEvent, listener: SprigListener): void;
     /**
      * Remove a listener for an event defined in ulEvents
      */
-    removeListener(event: string, listener: SprigListener): void;
+    removeListener(event: SprigEvent, listener: SprigListener): void;
     /**
      * Remove all listeners set on Sprig
      */
@@ -1046,4 +1110,4 @@ declare const _default: {
     configure: (config: NpmConfig) => sprigConfig.WindowSprig;
 };
 
-export { DismissReason, SprigAPI, WindowSprig$1 as WindowSprig, _default as default, sprig };
+export { DismissReason, SprigAPI, SprigEvent, WindowSprig$1 as WindowSprig, _default as default, sprig };