@inappstory/slide-api 0.0.2 → 0.0.3

package/dist/index.d.cts

@@ -1,3 +1,11 @@
+type WidgetRangeSliderOptions = WidgetOptionsBase & {
+    rangeClass: string;
+    activeClass: string;
+    horizontalClass: string;
+    verticalClass: string;
+    fillClass: string;
+    handleClass: string;
+};
 type WidgetRangeSliderSharedData = Record<string, 
 // element_id
 {
@@ -6,6 +14,74 @@ type WidgetRangeSliderSharedData = Record<string,
 }> & {
     ts: number; // unixtimestamp
 };
+declare class WidgetRangeSlider extends WidgetBase<WidgetRangeSliderOptions> {
+    static DEFAULTS: WidgetRangeSliderOptions;
+    static widgetClassName: string;
+    private label;
+    private topScale;
+    private startValue;
+    private snapPosition;
+    private hasSubmitButton;
+    private elementSlider;
+    private elementAverageResult;
+    private elementAverageResultTooltip;
+    private elementAverageResultTooltipLabelView;
+    private orientation;
+    private min;
+    private max;
+    private value;
+    private step;
+    private toFixed;
+    private fill;
+    private handle;
+    private range;
+    private DIMENSION;
+    private DIRECTION;
+    private DIRECTION_STYLE;
+    private COORDINATE;
+    private isClickCapturedBySlider;
+    private handleDimension;
+    private rangeDimension;
+    private maxHandlePos;
+    private grabPos;
+    private position;
+    private prevSnapValue;
+    /**
+     * @throws Error
+     * @param element
+     * @param options
+     */
+    constructor(element: HTMLElement, options: Partial<WidgetRangeSliderOptions>);
+    refreshUserData(localData: Record<string, any>): void;
+    private _statEventInputSave;
+    click(): boolean;
+    private completeWidget;
+    isDone(): boolean;
+    getIsClickCapturedBySlider(): boolean;
+    private displayAverageAnswer;
+    private init;
+    private update;
+    private handleDown;
+    private handleMove;
+    private handleEnd;
+    private cap;
+    private setPosition;
+    // Returns element position relative to the parent
+    private getPositionFromNode;
+    private getRelativePosition;
+    private getPercentageFromValue;
+    private getPositionFromValue;
+    private getValueFromPosition;
+    private setValue;
+    private destroy;
+    static api: {
+        initWidget: (element: HTMLElement, localData?: Record<string, any>) => void;
+        click: (element: HTMLElement) => boolean;
+        isClickCapturedBySlider: (element: HTMLElement) => boolean;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => void;
+    };
+}
+type WidgetPollOptions = WidgetOptionsBase;
 type WidgetPollSharedData = Record<string, 
 // element_id
 {
@@ -14,10 +90,93 @@ type WidgetPollSharedData = Record<string,
 }> & {
     ts: number; // unixtimestamp
 };
+declare class WidgetPoll extends WidgetBase<WidgetPollOptions> {
+    static DEFAULTS: {
+        slide: null;
+        activateAfterCreate: boolean;
+        create: boolean;
+        localData: {};
+    };
+    static widgetClassName: string;
+    private elementRect;
+    private label;
+    private percentFillMask;
+    private maskedVariants;
+    private variantsViewGroup;
+    private variants;
+    private variantsTexts;
+    private isInvertedPercentFilledMaskDirection;
+    private getUseResponseOnFirstButton;
+    private getUseResponseOnSecondButton;
+    private showClientTotalResult;
+    private selectedVariant;
+    private nativeDialogueWasOpened;
+    private answerDuration;
+    /**
+     * @throws Error
+     * @param element
+     * @param options
+     */
+    constructor(element: HTMLElement, options: Partial<WidgetPollOptions>);
+    refreshUserData(localData: Record<string, any>): void;
+    private _statEventPollAnswer;
+    private _statEventInputSave;
+    _selectVariant(index: number, filled?: boolean): void;
+    private _clearVariantSelection;
+    private selectVariant;
+    private _getVariantBoxInPercent;
+    displayPercents(selectedVariantIndex: number, filled?: boolean): void;
+    setUserText(text: string, buttonPosition: "first_button" | "second_button"): void;
+    private completeWidget;
+    isDone(): boolean;
+    slidePollIsDone(): boolean;
+    static api: {
+        initWidget: (element: HTMLElement, localData?: Record<string, any>) => void;
+        select: (element: HTMLElement) => boolean;
+        slidePollIsDone: (element: HTMLElement) => boolean;
+        setUserData: (id: string, text: string) => void;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => void;
+    };
+}
+type WidgetVoteOptions = WidgetOptionsBase;
 type WidgetVoteSharedData = Record<string, Array<number> // variant_index total count
 > & {
     ts: number; // unixtimestamp
 };
+declare class WidgetVote extends WidgetBase<WidgetVoteOptions> {
+    static DEFAULTS: WidgetVoteOptions;
+    static widgetClassName: string;
+    private question;
+    private answers;
+    private questionCount;
+    private selectedAnswer;
+    private label;
+    private variants;
+    private variantsTexts;
+    private selectedVariant;
+    private voteAllocation;
+    private hideClientTotalResult;
+    /**
+     * @throws Error
+     * @param element
+     * @param options
+     */
+    constructor(element: HTMLElement, options: Partial<WidgetVoteOptions>);
+    refreshUserData(localData: Record<string, any>): void;
+    private _statEventVoteVariant;
+    private _selectVariant;
+    selectVariant(variant: HTMLElement): boolean;
+    private displayPercents;
+    isDone(): boolean;
+    slideVoteIsDone(): boolean;
+    static api: {
+        fallbackInitOnMultiSlide: (element: HTMLElement, localData?: Record<string, any>) => void;
+        initWidget: (element: HTMLElement, localData?: Record<string, any>) => void;
+        select: (element: HTMLElement) => boolean;
+        slideVoteIsDone: (element: HTMLElement) => boolean;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => void;
+    };
+}
 type WidgetOptionsBase = {
     slide: HTMLElement | null;
     activateAfterCreate: boolean;
@@ -111,7 +270,7 @@ declare class WidgetsService {
 }
 declare class WidgetBase<WidgetOptions extends WidgetOptionsBase> {
     /**
-     * @see https://github.com/Microsoft/TypeScript/issues/3841#issuecomment-337560146
+     * @see https://github.com/Microsoft/TypeScript/issues/3841#issuecomment-1488919713
      */
     ["constructor"]: typeof WidgetBase;
     static DEFAULTS: WidgetOptionsBase;
@@ -276,6 +435,359 @@ interface SDKInterface {
      */
     storyShowNext(): void;
 }
+type WidgetCopyOptions = WidgetOptionsBase;
+declare class WidgetCopy extends WidgetBase<WidgetCopyOptions> {
+    static DEFAULTS: WidgetCopyOptions;
+    static widgetClassName: string;
+    private button;
+    private clipboardTarget;
+    private isPromotionalCode;
+    private state;
+    private msgNetworkError;
+    private msgServiceError;
+    private msgNoMoreCodes;
+    private msgTryAgain;
+    private geometry;
+    private resultLayer;
+    private resultLayerGeometry;
+    constructor(element: HTMLElement, options: Partial<WidgetCopyOptions>);
+    refreshUserData(localData: Record<string, any>): void;
+    private isTransparentElement;
+    private changeText;
+    private fetchPromoCode;
+    getStateValue(): number | null;
+    getIsPromotionalCode(): boolean;
+    private _statEventCopyClick;
+    private _select;
+    copyToClipboard(element: HTMLElement): void;
+    private completeWidget;
+    isDone(): boolean;
+    static api: {
+        initWidget: (nodeList: NodeListOf<HTMLElement>, localData?: Record<string, any>) => void;
+        click: (element: HTMLElement) => boolean;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => void;
+    };
+}
+type WidgetDataInputOptions = WidgetOptionsBase;
+declare class WidgetDataInput extends WidgetBase<WidgetDataInputOptions> {
+    static DEFAULTS: {
+        slide: null;
+        activateAfterCreate: boolean;
+        create: boolean;
+        localData: {};
+    };
+    static widgetClassName: string;
+    private label;
+    private elementRect;
+    private inputElement;
+    private textElement;
+    private inputPlaceholderValue;
+    /**
+     * @throws Error
+     * @param element
+     * @param options
+     */
+    constructor(element: HTMLElement, options: Partial<WidgetDataInputOptions>);
+    refreshUserData(localData: Record<string, any>): void;
+    private _statEventFocusIn;
+    private _statEventInputSave;
+    isDone(): boolean;
+    click(element: HTMLElement): boolean;
+    private _fillUserText;
+    setUserText(text: string): void;
+    static api: {
+        initWidget: (nodeList: NodeListOf<HTMLElement>, localData?: Record<string, any>) => void;
+        click: (element: HTMLElement) => boolean;
+        setUserData: (id: string, text: string) => void;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => void;
+    };
+}
+type WidgetDateCountdownOptions = WidgetOptionsBase & {
+    layers: Array<HTMLElement>;
+};
+declare class WidgetDateCountdown extends WidgetBase<WidgetDateCountdownOptions> {
+    static DEFAULTS: WidgetDateCountdownOptions;
+    static widgetClassName: string;
+    private label;
+    private layers;
+    private messages;
+    private timestampSeconds;
+    private diff;
+    private timerInited;
+    private pendingUpdate;
+    private firstGroup1;
+    private firstGroup2;
+    private firstGroupCaption;
+    private secondGroup1;
+    private secondGroup2;
+    private secondGroupCaption;
+    private thirdGroup1;
+    private thirdGroup2;
+    private thirdGroupCaption;
+    constructor(element: HTMLElement, options: Partial<WidgetDateCountdownOptions>);
+    refreshUserData(localData: Record<string, any>): void;
+    private pause;
+    private resume;
+    private initTimer;
+    private updateTimer;
+    private _asDuration;
+    static api: {
+        initWidget: (nodeList: NodeListOf<HTMLElement>, layers: Array<HTMLElement>, localData?: Record<string, any>) => void;
+        pause: (nodeList: NodeListOf<HTMLElement>) => void;
+        resume: (nodeList: NodeListOf<HTMLElement>) => void;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => void;
+    };
+}
+declare class WidgetMultiSlide {
+    static api: {
+        init: (slides: Array<HTMLElement>, localData?: Record<string, any>) => void;
+    };
+}
+type WidgetPollLayersOptions = WidgetOptionsBase & {
+    layers: Array<HTMLElement>;
+};
+declare class WidgetPollLayers extends WidgetBase<WidgetPollLayersOptions> {
+    static DEFAULTS: WidgetPollLayersOptions;
+    static widgetClassName: string;
+    private label;
+    private variants;
+    private variantsTexts;
+    private selectedVariant;
+    private layers;
+    constructor(element: HTMLElement, options: Partial<WidgetPollLayersOptions>);
+    refreshUserData(localData: Record<string, any>): void;
+    private _statEventPollVariant;
+    private _selectVariant;
+    selectVariant(variant: HTMLElement): boolean;
+    private completeWidget;
+    isDone(): boolean;
+    slidePollIsDone(): boolean;
+    static api: {
+        initWidget: (element: HTMLElement, layers: Array<HTMLElement>, localData?: Record<string, any>) => void;
+        select: (element: HTMLElement) => boolean;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => void;
+    };
+}
+type WidgetQuestOptions = WidgetOptionsBase;
+declare class WidgetQuest extends WidgetBase<WidgetQuestOptions> {
+    static DEFAULTS: WidgetQuestOptions;
+    static widgetClassName: string;
+    private selectedAnswer;
+    protected label: HTMLElement | null;
+    protected variants: Array<HTMLElement>;
+    private isWidget;
+    private slideCount;
+    private nonFinalSlide;
+    private finalSlide;
+    constructor(element: HTMLElement, options: Partial<WidgetQuestOptions>);
+    refreshUserData(localData: Record<string, any>): void;
+    private setStorySessionValue;
+    private getStorySessionValue;
+    private init;
+    private _selectAnswer;
+    selectAnswer(answer: HTMLElement): boolean;
+    isDone(): boolean;
+    slideQuestIsDone(): boolean;
+    private firstSlideWithQuestIndex;
+    private lastSlideWithQuestIndex;
+    private _getRoutes;
+    private _addNewRouteHistory;
+    private _routeMvPtrBack;
+    private getLastSlideIndexFromRouteHistory;
+    private handleRouteClick;
+    static api: {
+        initWidget: (element: HTMLElement, localData?: Record<string, any>) => Promise<boolean>;
+        select: (element: HTMLElement) => boolean;
+        slideTestIsDone: (element: HTMLElement) => boolean;
+        handleRouteClick: (element: HTMLElement, event: {
+            direction: "backward" | "forward";
+            slideIndex: number;
+            slideCount: number;
+            click: () => void;
+        }) => void;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => void;
+    };
+}
+type WidgetQuizOptions = WidgetOptionsBase;
+declare class WidgetQuiz extends WidgetBase<WidgetQuizOptions> {
+    static DEFAULTS: WidgetQuizOptions;
+    static widgetClassName: string;
+    private question;
+    private answers;
+    private questionCount;
+    private selectedAnswer;
+    constructor(element: HTMLElement, options: Partial<WidgetQuizOptions>);
+    refreshUserData(localData: Record<string, any>): void;
+    private _selectAnswer;
+    private _clearAnswerSelection;
+    selectAnswer(answer: HTMLElement): boolean;
+    isDone(): boolean;
+    slideQuizIsDone(): boolean;
+    static api: {
+        initWidget: (element: HTMLElement, localData?: Record<string, any>) => void;
+        select: (element: HTMLElement) => boolean;
+        slideQuizIsDone: (element: HTMLElement) => boolean;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => void;
+    };
+}
+type WidgetQuizGroupedOptions = WidgetOptionsBase;
+declare class WidgetQuizGrouped extends WidgetBase<WidgetQuizGroupedOptions> {
+    static DEFAULTS: {
+        slide: null;
+        activateAfterCreate: boolean;
+        create: boolean;
+        localData: {};
+    };
+    static widgetClassName: string;
+    private question;
+    private answers;
+    private questionCount;
+    private selectedAnswer;
+    /**
+     * @throws Error
+     * @param element
+     * @param options
+     */
+    constructor(element: HTMLElement, options: Partial<WidgetQuizGroupedOptions>);
+    refreshUserData(localData: Record<string, any>): void;
+    private _selectAnswer;
+    private _clearAnswerSelection;
+    private _updateScore;
+    private selectAnswer;
+    isDone(): boolean;
+    slideQuizIsDone(): boolean;
+    static api: {
+        initWidget: (element: HTMLElement, localData?: Record<string, any>) => void;
+        select: (element: HTMLElement) => boolean;
+        slideQuizIsDone: (element: HTMLElement) => boolean;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => void;
+    };
+}
+type WidgetRateOptions = WidgetOptionsBase;
+declare class WidgetRate extends WidgetBase<WidgetRateOptions> {
+    static DEFAULTS: WidgetRateOptions;
+    static widgetClassName: string;
+    private elementRect;
+    private label;
+    private nativeDialogueWasOpened;
+    private stars;
+    private submitToStores;
+    private submitToStoresMin;
+    private submitToStoresMax;
+    private showDialogOnLowRate;
+    private showDialogueMin;
+    private showDialogueMax;
+    private selectedStar;
+    private answerSelectDuration;
+    constructor(element: HTMLElement, options: Partial<WidgetRateOptions>);
+    refreshUserData(localData: Record<string, any>): void;
+    private _statEventRateUsAnswer;
+    private _selectStar;
+    private _clearSelectedStar;
+    private selectStar;
+    setUserText(text: string): void;
+    private completeWidget;
+    isDone(): boolean;
+    slideRateIsDone(): boolean;
+    static api: {
+        initWidget: (nodeList: NodeListOf<HTMLElement>, localData?: Record<string, any>) => void;
+        select: (element: HTMLElement) => boolean;
+        slidePollIsDone: (element: HTMLElement) => boolean;
+        setUserData: (id: string, text: string) => void;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => void;
+    };
+}
+type WidgetShareOptions = WidgetOptionsBase & {
+    layers: Array<HTMLElement>;
+};
+declare class WidgetShare extends WidgetBase<WidgetShareOptions> {
+    static DEFAULTS: WidgetShareOptions;
+    static widgetClassName: string;
+    private layers;
+    private shareType;
+    private shareTarget;
+    private withLayer;
+    private btnDisabled;
+    constructor(element: HTMLElement, options: Partial<WidgetShareOptions>);
+    refreshUserData(localData: Record<string, any>): void;
+    private _statEventShare;
+    private share;
+    _complete(isSuccess: boolean): void;
+    isDone(): boolean;
+    static api: {
+        initWidget: (nodeList: NodeListOf<HTMLElement>, layers: Array<HTMLElement>, localData?: Record<string, any>) => void;
+        click: (element: HTMLElement) => void;
+        complete: (id: string, isSuccess: boolean) => void;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => void;
+    };
+}
+type WidgetTestOptions = WidgetOptionsBase;
+declare class WidgetTest extends WidgetBase<WidgetTestOptions> {
+    static DEFAULTS: WidgetTestOptions;
+    static widgetClassName: string;
+    private label;
+    private variants;
+    private testCount;
+    private selectedAnswer;
+    private withTimeToAnswer;
+    private answerTimeout;
+    private tick;
+    private cancelTick;
+    private animationFrameId;
+    private startTimerAt;
+    private timeLeft;
+    private timeLeftDefault;
+    private timeline;
+    constructor(element: HTMLElement, options: Partial<WidgetTestOptions>);
+    refreshUserData(localData: Record<string, any>): void;
+    private _statEventVoteAnswer;
+    private _selectAnswer;
+    selectAnswer(answer: HTMLElement): boolean;
+    private doneWithoutAnswer;
+    // complete answer select and save local data + stat event
+    private _completeWidget;
+    isDone(): boolean;
+    slideTestIsDone(): boolean;
+    slideTestWithTimer(): boolean;
+    static api: {
+        initWidget: (element: HTMLElement, localData?: Record<string, any>) => void;
+        select: (element: HTMLElement) => boolean;
+        slideTestIsDone: (element: HTMLElement) => boolean;
+        slideTestWithTimer: (element: HTMLElement) => boolean;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => void;
+    };
+}
+type WidgetCopyApi = typeof WidgetCopy.api;
+type WidgetDataInputApi = typeof WidgetDataInput.api;
+type WidgetDateCountdownApi = typeof WidgetDateCountdown.api;
+type WidgetMultiSlideApi = typeof WidgetMultiSlide.api;
+type WidgetPollApi = typeof WidgetPoll.api;
+type WidgetPollLayersApi = typeof WidgetPollLayers.api;
+type WidgetQuestApi = typeof WidgetQuest.api;
+type WidgetQuizApi = typeof WidgetQuiz.api;
+type WidgetQuizGroupedApi = typeof WidgetQuizGrouped.api;
+type WidgetRangeSliderApi = typeof WidgetRangeSlider.api;
+type WidgetRateApi = typeof WidgetRate.api;
+type WidgetShareApi = typeof WidgetShare.api;
+type WidgetTestApi = typeof WidgetTest.api;
+type WidgetVoteApi = typeof WidgetVote.api;
+type SlideApi = {
+    Animation: IAnimation;
+    WidgetCopy: WidgetCopyApi;
+    WidgetDataInput: WidgetDataInputApi;
+    WidgetDateCountdown: WidgetDateCountdownApi;
+    WidgetMultiSlide: WidgetMultiSlideApi;
+    WidgetPoll: WidgetPollApi;
+    WidgetPollLayers: WidgetPollLayersApi;
+    WidgetQuest: WidgetQuestApi;
+    WidgetQuiz: WidgetQuizApi;
+    WidgetQuizGrouped: WidgetQuizGroupedApi;
+    WidgetRangeSlider: WidgetRangeSliderApi;
+    WidgetRate: WidgetRateApi;
+    WidgetShare: WidgetShareApi;
+    WidgetTest: WidgetTestApi;
+    WidgetVote: WidgetVoteApi;
+};
 declare const getSlideApi: (_sdkInterface: SDKInterface) => {
     Animation: IAnimation;
     WidgetCopy: {
@@ -369,4 +881,4 @@ declare const getSlideApi: (_sdkInterface: SDKInterface) => {
     };
 };
 export { getSlideApi };
-export type { SDKInterface };
+export type { SDKInterface, SlideApi, WidgetCopyApi, WidgetDataInputApi, WidgetDateCountdownApi, WidgetMultiSlideApi, WidgetPollApi, WidgetPollLayersApi, WidgetQuestApi, WidgetQuizApi, WidgetQuizGroupedApi, WidgetRangeSliderApi, WidgetRateApi, WidgetShareApi, WidgetTestApi, WidgetVoteApi, IAnimation };