@sprig-technologies/sprig-browser 2.26.6 → 2.27.0

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("./index-CqSba42x.cjs");exports.DismissReason=e.DismissReason;exports.SprigAPI=e.SprigAPI;exports.SprigEvent=e.SprigEvent;exports.default=e.index;exports.sprig=e.sprig;
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("./index-CbFaIXGg.cjs");exports.DismissReason=e.DismissReason;exports.SprigAPI=e.SprigAPI;exports.SprigEvent=e.SprigEvent;exports.default=e.index;exports.sprig=e.sprig;

package/dist/index.d.ts

@@ -2087,6 +2087,7 @@ interface OpenTextCard extends BaseCard {
             buttonText?: string;
             captionText?: string;
             conceptUrl: ConceptUrl;
+            footerHtml?: string;
             openTextPlaceholder?: string;
             required: boolean;
             richTextBody: RichTextBody;
@@ -2196,10 +2197,11 @@ interface VideoVoiceCard extends BaseCard {
 }
 type Card = TextUrlPromptCard | ConsentLegalCard | RecordedTaskCard | LikertCard | OpenTextCard | MatrixCard | MultipleChoiceSingleSelectCard | MultipleChoiceMultiSelectCard | NPSCard | VideoVoiceCard;
 
-type MatchType = "exactly" | "legacy";
+type InteractiveMatchType = "exactly" | "legacy";
+type PageUrlMatchType = "contains" | "exactly" | "legacy" | "notContains" | "regex" | "startsWith";
 interface InteractiveEvent {
     id: number;
-    matchType: MatchType;
+    matchType: InteractiveMatchType;
     name: string;
     pattern: string;
     properties: {
@@ -2210,17 +2212,22 @@ interface InteractiveEvent {
 }
 interface PageUrlEvent {
     id: number;
-    matchType: MatchType | "contains" | "notContains" | "regex" | "startsWith";
+    matchType: PageUrlMatchType;
     pattern: string;
 }
 
 declare enum DismissReason {
     Closed = "close.click",
     Complete = "survey.completed",
+    FeedbackClosed = "feedback.closed",
     PageChange = "page.change",
     API = "api",
     Override = "override"
 }
+declare enum StudyType {
+    Feedback = "feedbackButton",
+    IPS = "inProductSurvey"
+}
 declare enum SprigEvent {
     ReplayCapture = "replay.capture",
     SDKReady = "sdk.ready",
@@ -2283,10 +2290,14 @@ declare const enum InternalEventData {
     Props = "props"
 }
 
-interface RecordedTaskResponseType {
-    questionId: number;
-    type: CardType;
-    value: RecordedTaskResponseValueType;
+declare const enum ThresholdType {
+    Max = "max",
+    Min = "min"
+}
+interface MetricThreshold {
+    metric: string;
+    type: ThresholdType;
+    value: number;
 }
 
 declare enum ReplayDurationType {
@@ -2323,7 +2334,16 @@ type EventDigest = {
     type: ReplayEventType.SurveySubmitted;
 };
 
+interface RecordedTaskResponseType {
+    questionId: number;
+    type: CardType;
+    value: RecordedTaskResponseValueType;
+}
+
 interface MobileReplayConfig {
+    mobileMetricsReportingEnabled?: boolean;
+    metricsReportingInterval?: number;
+    metricsThresholds?: MetricThreshold[];
     maxMobileReplayDurationSeconds?: number;
     mobileReplaySettings?: {
         hideAllFormContents: boolean;
@@ -2365,6 +2385,7 @@ type SprigEventMap = {
         {
             initiator?: string;
             name: string;
+            studyType?: StudyType;
         }
     ];
     [SprigEvent.SurveyFadingOut]: [];
@@ -2393,6 +2414,7 @@ type SprigEventMap = {
         {
             initiator: DismissReason;
             name?: string;
+            studyType?: StudyType;
         }
     ];
     [SprigEvent.SurveyWillPresent]: [
@@ -2507,6 +2529,21 @@ interface Answer {
     questionId: number;
     value: unknown;
 }
+declare enum FeedbackPlacement {
+    CenterLeft = "center-left",
+    CenterRight = "center-right",
+    BottomLeft = "bottom-left",
+    BottomRight = "bottom-right"
+}
+declare enum FeedbackDesktopDisplay {
+    CenterModal = "center-modal",
+    Slider = "slider"
+}
+interface AppProductConfig {
+    framePosition?: FramePosition;
+    desktopDisplay?: FeedbackDesktopDisplay;
+    placement?: FeedbackPlacement;
+}
 interface Config extends MobileReplayConfig {
     allResponses: unknown[];
     answers?: Answer[];
@@ -2567,6 +2604,7 @@ interface Config extends MobileReplayConfig {
     installationMethod?: InstallationMethod;
     interactiveEvents: InteractiveEvent[];
     interactiveEventsHandler?: (e: MouseEvent) => void;
+    isOnQuestionsTab?: boolean;
     isPreview?: boolean;
     launchDarklyEnabled?: boolean;
     locale: string;
@@ -2590,6 +2628,7 @@ interface Config extends MobileReplayConfig {
     platform?: Platform;
     previewKey?: string | null;
     previewLanguage?: string;
+    productConfig?: AppProductConfig;
     replayNonce?: string;
     replaySettings?: object;
     requireUserIdForTracking: boolean;
@@ -2599,6 +2638,7 @@ interface Config extends MobileReplayConfig {
     slugName: null;
     startingQuestionIdx?: number | null;
     styleNonce?: string;
+    studyType?: StudyType;
     surveyId: number;
     tabTitle: string;
     ulEvents: typeof SprigEvent;
@@ -2722,6 +2762,7 @@ declare namespace sprigConfig {
     }) => Promise<string | null>;
     _previewSurvey: (surveyTemplateId: UUID) => void;
     _reviewSurvey: (surveyId: number) => void;
+    _reportMetric: (name: string, value: number) => void;
 
     // external apis
     addListener: (event: SprigEvent, listener: SprigListener) => Promise<void>;
@@ -2897,7 +2938,9 @@ declare class SprigAPI {
         SURVEY_WIDTH: SprigEvent;
         SURVEY_PRESENTED: SprigEvent;
         SURVEY_LIFE_CYCLE: SprigEvent;
-        SURVEY_WILL_CLOSE: SprigEvent;
+        SURVEY_WILL_CLOSE: SprigEvent; /**
+         * Attach a user id to the visitor
+         */
         SURVEY_WILL_PRESENT: SprigEvent;
         QUESTION_ANSWERED: SprigEvent;
         REPLAY_CAPTURE: SprigEvent;

package/dist/index.js

@@ -1,4 +1,4 @@
-import { D as i, w as r, S as e, y as p, x as g } from "./index-Dc62vWMo.js";
+import { D as i, x as r, S as e, z as p, y as g } from "./index-Co-eH2O1.js";
 export {
   i as DismissReason,
   r as SprigAPI,