@sprig-technologies/sprig-browser 2.19.7 → 2.20.0

package/dist/src/types/card.d.ts

@@ -0,0 +1,292 @@
+export declare const enum CardType {
+    ConsentLegal = "consentlegal",
+    Likert = "likert",
+    MultipleChoice = "multiplechoice",
+    MultipleSelect = "multipleselect",
+    NPS = "nps",
+    Open = "open",
+    RecordedTask = "recordedtask",
+    TextUrlPrompt = "texturlprompt",
+    Thanks = "thanks",
+    Uploading = "uploading",
+    VideoVoice = "videovoice"
+}
+export declare type ConceptUrl = string | null;
+interface BaseCard {
+    name: number;
+    surveyId: number;
+    updatedAt: string;
+    value?: unknown;
+}
+export declare const enum Comparator {
+    Answered = "answered",
+    Equal = "eq",
+    NotEqual = "neq",
+    Skipped = "skipped",
+    LessThan = "lt",
+    LessThanOrEqual = "lte",
+    GivenUp = "given_up",
+    GreaterThan = "gt",
+    GreaterThanOrEqual = "gte",
+    ListAll = "list_all",
+    ListAtLeastOne = "list_alo",
+    ListExact = "list_exact"
+}
+export declare type DefaultComparator = Comparator.Answered | Comparator.Skipped;
+export interface RoutingOption<C extends Comparator = DefaultComparator> {
+    comparator: C;
+    target: number;
+    /** @example '', 'option_2', ['option_1'] */
+    value: number | string | string[];
+}
+declare type RoutingOptions<C extends Comparator = DefaultComparator> = RoutingOption<C | DefaultComparator>[] | null;
+/** @example <p>Body</p> */
+declare type RichTextBody = string;
+export declare const enum PromptActionType {
+    Continue = "CONTINUE",
+    External = "EXTERNAL"
+}
+export interface TextUrlPromptCard extends BaseCard {
+    props: {
+        message: string;
+        options: [];
+        properties: {
+            body: string;
+            buttonText?: string;
+            buttonUrl?: string;
+            conceptUrl: ConceptUrl;
+            promptActionType: PromptActionType;
+            required: boolean;
+            richTextBody: RichTextBody;
+        };
+        routingOptions: RoutingOptions;
+    };
+    type: CardType.TextUrlPrompt;
+}
+export declare const enum AvPermission {
+    Camera = "camera",
+    Microphone = "microphone",
+    Screen = "screen"
+}
+export interface ConsentLegalCard extends BaseCard {
+    props: {
+        message: string;
+        options: [];
+        properties: {
+            body: string;
+            captionText: string;
+            collectName: boolean;
+            conceptUrl: ConceptUrl;
+            consentText: string;
+            nameLabelText: string;
+            required: boolean;
+            richTextBody: RichTextBody;
+            skipButtonText: string;
+            submitButtonText: string;
+        };
+        routingOptions: RoutingOptions;
+    };
+    type: CardType.ConsentLegal;
+}
+interface BaseTaskPage {
+    buttonText: string;
+    headline: string;
+}
+export declare const enum RecordedTaskPageType {
+    AvPermission = "av_permission",
+    ScreenPermission = "screen_permission",
+    StartTask = "start_task",
+    CompleteTask = "complete_task"
+}
+export interface PermissionTaskPage extends BaseTaskPage {
+    captionText: string;
+    headline: string;
+    permissionDeniedBody: string;
+    permissionDeniedHeadline: string;
+    permissionDescriptors: AvPermission[];
+    permissionGrantedCaptionText?: string;
+    permissionGrantedHeadline?: string;
+    skipButtonText?: string;
+    svg: string;
+    tryAgainButtonText: string;
+    type: RecordedTaskPageType.AvPermission;
+}
+export interface ScreenTaskPage extends BaseTaskPage {
+    captionText: string;
+    permissionDeniedCaptionText: string;
+    permissionDeniedHeadline: string;
+    selectTabText: string;
+    skipButtonText: string;
+    type: RecordedTaskPageType.ScreenPermission;
+}
+export interface StartTaskPage extends BaseTaskPage {
+    captionText?: string;
+    taskDetail: string;
+    type: RecordedTaskPageType.StartTask;
+}
+export interface CompleteTaskPage extends BaseTaskPage {
+    captionText?: string;
+    skipButtonText: string;
+    taskDetail: string;
+    type: RecordedTaskPageType.CompleteTask;
+}
+export declare type RecordedTaskPage = PermissionTaskPage | ScreenTaskPage | StartTaskPage | CompleteTaskPage;
+export interface RecordedTaskCardProperties {
+    captionText: string;
+    conceptUrl: ConceptUrl;
+    pages: RecordedTaskPage[];
+    permissions: AvPermission[];
+    required: boolean;
+    taskDetail: string;
+}
+export interface RecordedTaskCard extends BaseCard {
+    props: {
+        message: string;
+        options: [];
+        properties: RecordedTaskCardProperties;
+        routingOptions: RoutingOptions<Comparator.GivenUp>;
+    };
+    type: CardType.RecordedTask;
+}
+interface Labels {
+    left: string;
+    right: string;
+}
+export interface RatingIcon {
+    idx?: number;
+    svg: string;
+}
+export declare enum ScaleLabelType {
+    Number = "number",
+    Smiley = "smiley",
+    Star = "star"
+}
+export interface LikertCard extends BaseCard {
+    props: {
+        labels: Labels;
+        message: string;
+        options: [];
+        properties: {
+            captionText: string;
+            buttonText?: string;
+            conceptUrl: ConceptUrl;
+            labels: Labels;
+            range: string;
+            ratingIcons: RatingIcon[];
+            scaleLabelType: ScaleLabelType;
+            required: boolean;
+        };
+        routingOptions: RoutingOptions<Comparator.Equal | Comparator.GivenUp | Comparator.GreaterThan | Comparator.GreaterThanOrEqual | Comparator.LessThan | Comparator.LessThanOrEqual | Comparator.NotEqual>;
+    };
+    type: CardType.Likert;
+}
+export interface OpenTextCard extends BaseCard {
+    props: {
+        message: string;
+        options: [];
+        properties: {
+            body: string;
+            buttonText?: string;
+            captionText?: string;
+            conceptUrl: ConceptUrl;
+            openTextPlaceholder?: string;
+            required: boolean;
+            richTextBody: RichTextBody;
+            skipButtonText?: string;
+        };
+        routingOptions: RoutingOptions;
+    };
+    type: CardType.Open;
+}
+export interface MultipleChoiceOption {
+    createdAt: string;
+    deletedAt: null;
+    id: number;
+    label: string;
+    optionProperties: null | {
+        allowsTextEntry: boolean;
+    };
+    order: number;
+    productId: number;
+    surveyId: number;
+    surveyQuestionId: number;
+    updatedAt: string;
+    value: string;
+}
+export interface CommonMultipleChoiceProps {
+    message: string;
+    options: MultipleChoiceOption[];
+    properties: {
+        buttonText?: string;
+        captionText: string;
+        conceptUrl: ConceptUrl;
+        randomize: "none" | "keeplast" | "all";
+        required: true;
+    };
+}
+export interface MultiChoiceCard<C extends Comparator = DefaultComparator> extends BaseCard {
+    props: CommonMultipleChoiceProps & {
+        routingOptions: RoutingOptions<C>;
+    };
+}
+export interface MultipleChoiceSingleSelectCard extends MultiChoiceCard<Comparator.Equal | Comparator.NotEqual> {
+    type: CardType.MultipleChoice;
+}
+export interface MultipleChoiceMultiSelectCard extends MultiChoiceCard<Comparator.ListAll | Comparator.ListAtLeastOne | Comparator.ListExact> {
+    type: CardType.MultipleSelect;
+}
+export interface NPSCard extends BaseCard {
+    props: {
+        labels: {
+            left: string;
+            right: string;
+        };
+        message: string;
+        options: [];
+        properties: {
+            buttonText?: string;
+            captionText: string;
+            conceptUrl: null;
+            labels: {
+                left: string;
+                right: string;
+            };
+            required: boolean;
+        };
+        routingOptions: RoutingOptions<Comparator.Equal | Comparator.GreaterThan | Comparator.GreaterThanOrEqual | Comparator.LessThan | Comparator.LessThanOrEqual | Comparator.NotEqual>;
+    };
+    type: CardType.NPS;
+}
+export interface VideoVoiceCard extends BaseCard {
+    props: {
+        message: string;
+        options: [];
+        properties: {
+            buttonText: string;
+            captionText: string;
+            conceptUrl: null;
+            mediaType: "video" | "audio";
+            required: boolean;
+            skipButtonText: string;
+            uploadId: string;
+            videoUrl: string;
+        };
+        routingOptions: RoutingOptions;
+    };
+    type: CardType.VideoVoice;
+}
+export interface UploadingCard extends Pick<BaseCard, "name"> {
+    props: {
+        routingOptions: [];
+    };
+    type: CardType.Uploading;
+}
+export interface ThanksCard extends Pick<BaseCard, "name"> {
+    props: {
+        routingOptions: [];
+    };
+    type: CardType.Thanks;
+}
+export declare type Card = TextUrlPromptCard | ConsentLegalCard | RecordedTaskCard | LikertCard | OpenTextCard | MultipleChoiceSingleSelectCard | MultipleChoiceMultiSelectCard | NPSCard | VideoVoiceCard;
+export declare type AppCard = Card | UploadingCard | ThanksCard;
+export {};

package/dist/src/types/config.d.ts

@@ -0,0 +1,232 @@
+import { DismissReason, SprigEvent } from "../constants/sprigEvents";
+import { SprigEventEmitter } from "../helpers/eventEmitter";
+import { AppCard, Card, CardType } from "./card";
+import { InteractiveEvent, PageUrlEvent } from "./event";
+export declare const enum FramePosition {
+    BottomLeft = "bottomLeft",
+    BottomRight = "bottomRight",
+    Center = "center",
+    TopLeft = "topLeft",
+    TopRight = "topRight"
+}
+export declare const enum HttpHeader {
+    Error = "x-ul-error",
+    EnvironmentID = "x-ul-environment-id",
+    InstallationMethod = "x-ul-installation-method",
+    PartnerAnonymousId = "x-ul-anonymous-id",
+    Platform = "userleap-platform",
+    PreviewMode = "x-ul-preview-mode",
+    UserID = "x-ul-user-id",
+    VisitorID = "x-ul-visitor-id"
+}
+export declare const enum Platform {
+    Email = "email",
+    Link = "link",
+    Web = "web"
+}
+export declare const enum InstallationMethod {
+    Npm = "web-npm",
+    Gtm = "web-gtm",
+    Segment = "web-segment",
+    Snippet = "web-snippet"
+}
+interface Answer {
+    questionId: number;
+    value: unknown;
+}
+export interface Config {
+    answers?: Answer[];
+    apiURL: string;
+    /** @example "#000000" */
+    border: string;
+    cards: Card[];
+    configureExitOnOverlayClick: (cb: () => void) => void;
+    context: {
+        outcome: string;
+        product: {
+            name: string;
+        };
+        visitor: {
+            outcome: string;
+        };
+    };
+    customMetadata?: Record<string, unknown>;
+    customStyles: string;
+    dismissOnPageChange: boolean;
+    endCard: {
+        headline: string;
+        subheader?: string;
+    };
+    /** @example "SJcVfq-7QQ" */
+    envId: string;
+    environmentId?: string;
+    eventEmitFn: SprigEventEmitter["emit"];
+    fontFamily?: string;
+    fontFamilyURL: undefined;
+    frame: HTMLIFrameElement & {
+        eventEmitter?: SprigEventEmitter;
+        setHeight?: (height: number) => void;
+    };
+    framePosition: FramePosition;
+    headers: {
+        "accept-language"?: string;
+        /** @example "Bearer 123" */
+        Authorization?: string;
+        "Content-Type": string;
+        "userleap-platform": Platform;
+        /** @example "SJcVfq-7QQ" */
+        [HttpHeader.EnvironmentID]?: string;
+        [HttpHeader.InstallationMethod]: InstallationMethod;
+        [HttpHeader.PartnerAnonymousId]?: string;
+        [HttpHeader.PreviewMode]?: string;
+        /** @example "2.18.0" */
+        "x-ul-sdk-version": string;
+        [HttpHeader.UserID]?: string;
+        [HttpHeader.VisitorID]?: UUID;
+    };
+    installationMethod?: InstallationMethod;
+    interactiveEvents: InteractiveEvent[];
+    interactiveEventsHandler?: (e: MouseEvent) => void;
+    isPreview?: boolean;
+    locale: string;
+    marketingUrl?: string;
+    maxAttrNameLength: number;
+    maxAttrValueLength: number;
+    maxEmailLength: number;
+    maxEventLength: number;
+    maxUserIdLength: number;
+    mobileSDKVersion: undefined;
+    mode?: string;
+    mute?: boolean;
+    optimizelyEnabled: boolean;
+    overlayStyle: "light";
+    overlayStyleMobile: "none";
+    pageUrlEvents: PageUrlEvent[];
+    path?: string;
+    platform?: Platform;
+    requireUserIdForTracking: boolean;
+    responseGroupUid: UUID;
+    showStripes: boolean;
+    showSurveyBrand: boolean;
+    slugName: null;
+    startingQuestionIdx?: number | null;
+    styleNonce?: string;
+    surveyId: number;
+    tabTitle: string;
+    ulEvents: SprigEvent;
+    UpChunk: Window["UpChunk"];
+    useDesktopPrototype?: boolean;
+    useMobileStyling: boolean;
+    userId: UUID | null;
+    visitorId: UUID | null;
+    viewDocument: Document;
+    viewWindow: Window;
+    visitorAttributes: {
+        email?: string;
+        externalUserId?: string;
+    };
+}
+export interface ResponseData {
+    answeredAt?: number;
+    questionId: number;
+    value: unknown;
+    type: CardType;
+}
+export interface Submission {
+    completedAt: number;
+    response: {
+        answeredAt?: number;
+        value: unknown;
+    };
+    responseGroupUid: AppConfig["responseGroupUid"];
+}
+export interface AppConfig {
+    apiURL: Config["apiURL"];
+    answers: Config["answers"];
+    border: Config["border"];
+    cards: AppCard[];
+    configureExitOnOverlayClick: Config["configureExitOnOverlayClick"];
+    customMetadata: Config["customMetadata"];
+    endCard: Config["endCard"];
+    envId: Config["envId"];
+    eventEmitFn: Config["eventEmitFn"];
+    fontFamily?: Config["fontFamily"];
+    frame: Config["frame"];
+    headers: Config["headers"];
+    index: number;
+    hasViewedEmbed: boolean;
+    isPreview: Config["isPreview"];
+    marketingUrl: Config["marketingUrl"];
+    meta: {
+        ch: number;
+        cw: number;
+        l: string;
+        mode: Config["mode"] | null;
+        p: string;
+        sh: number;
+        sw: number;
+    };
+    mode: Config["mode"];
+    recorderEventEmitter: SprigEventEmitter;
+    responseGroupUid: Config["responseGroupUid"];
+    slugName: Config["slugName"];
+    showStripes: Config["showStripes"];
+    showSurveyBrand: Config["showSurveyBrand"];
+    styleNonce: Config["styleNonce"];
+    surveyId: Config["surveyId"];
+    tabTitle: Config["tabTitle"];
+    uploadingCardViewed: boolean;
+    uploadProgress: Record<string, {
+        isComplete: boolean;
+        isSubmitted: boolean;
+        progressPct: number;
+    }>;
+    useDesktopPrototype: Config["useDesktopPrototype"];
+    useMobileStyling: Config["useMobileStyling"];
+    userId: Config["userId"];
+    viewDocument: Config["viewDocument"];
+    viewedCardCount: number;
+    visitorAttributes?: Config["visitorAttributes"];
+    close: (id?: string) => void;
+    handleClickEmbedButton: (id: string) => void;
+    /**
+     * If the current card is not the uploading card, update the given upload state for this mediaRecordingUid directly in state,
+     * without using update, which would reset video player.
+     * If the current card is the uploading card,
+     *  check if upload is complete: if so and there's no end card, destroy the app.
+     *  since we're on the end card, update the state using store, which allows for dynamic progress updates.
+     */
+    handleUploadUpdate: (options: {
+        mediaRecordingUid: UUID;
+        isComplete?: boolean;
+        progressPct?: number;
+        isSubmitted?: boolean;
+    }) => void;
+    destroy: (id: string) => void;
+    fadeout: (id: string) => void;
+    recorder: () => void;
+    remove: (options: {
+        initiator: DismissReason;
+    }) => void;
+    next: (options: {
+        completeSurvey: () => void;
+        data: ResponseData;
+        endCard?: AppConfig["endCard"];
+    }) => void;
+    submit: (submission: Submission) => Promise<void>;
+    trackHistory: (options: {
+        event: string;
+        index?: number;
+        isNew?: boolean;
+    }) => void;
+    update: (id?: string) => void;
+}
+export interface ProductConfig {
+    customStyles: string;
+    exitOnOverlayClick: boolean;
+    exitOnOverlayClickMobile: boolean;
+    framePosition: FramePosition;
+    overlayStyle: "dark" | "light";
+    overlayStyleMobile: "dark" | "light" | "none";
+}
+export {};

package/dist/src/types/event.d.ts

@@ -0,0 +1,18 @@
+declare type MatchType = "exactly" | "legacy";
+export interface InteractiveEvent {
+    id: number;
+    matchType: MatchType;
+    name: string;
+    pattern: string;
+    properties: {
+        innerText: string;
+        selector?: string;
+        type?: "click";
+    };
+}
+export interface PageUrlEvent {
+    id: number;
+    matchType: MatchType | "contains" | "notContains" | "regex" | "startsWith";
+    pattern: string;
+}
+export {};