@inappstory/slide-api 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 InAppStory
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/index.cjs.d.ts

@@ -0,0 +1,372 @@
+type WidgetRangeSliderSharedData = Record<string, 
+// element_id
+{
+    total_value: number;
+    total_user: number;
+}> & {
+    ts: number; // unixtimestamp
+};
+type WidgetPollSharedData = Record<string, 
+// element_id
+{
+    0: number; // answer_yes total count
+    1: number; // answer_no total count
+}> & {
+    ts: number; // unixtimestamp
+};
+type WidgetVoteSharedData = Record<string, Array<number> // variant_index total count
+> & {
+    ts: number; // unixtimestamp
+};
+type WidgetOptionsBase = {
+    slide: HTMLElement | null;
+    activateAfterCreate: boolean;
+    create: boolean;
+    localData: Record<string, any>;
+} & {
+    [P in string]: any;
+};
+declare const enum Widgets {
+    DataInput = "dataInput",
+    Quiz = "quiz",
+    QuizGrouped = "quizGrouped",
+    RangeSlider = "rangeSlider",
+    Poll = "poll",
+    PollLayers = "pollLayers",
+    Vote = "vote",
+    Rate = "rate",
+    Test = "test",
+    Copy = "copy",
+    Share = "share",
+    DateCountdown = "dateCountdown",
+    Quest = "quest"
+}
+interface WidgetsSharedDataMap {
+    rangeSlider: WidgetRangeSliderSharedData;
+    poll: WidgetPollSharedData;
+    vote: WidgetVoteSharedData;
+}
+interface IAnimation {
+    start(slide: HTMLElement, animate?: boolean): void;
+    stop(slide: HTMLElement, animate?: boolean): void;
+    pause(slide: HTMLElement): void;
+    resume(slide: HTMLElement): void;
+    reset(slide: HTMLElement): void;
+}
+type APIResponse<DTO> = {
+    status: number;
+    data: DTO;
+    headers?: {
+        [key: string]: string;
+    };
+    requestId: number | string;
+};
+interface SDKApi {
+    getStoryServerData(storyId: number): Record<string, any> | null;
+    getSlideDuration(storyId: number, slideIndex: number): number | null;
+    showNextSlide(duration: number): void;
+    sendStatisticEvent(name: string, data: Record<string, string | number>, devPayload?: Record<string, string | number>): void;
+    getStoryLocalData(): Promise<Record<string, any>>;
+    isExistsShowLayer(): boolean;
+    showLayer(index: number): void;
+    storyAnimation: IAnimation | undefined;
+    isAndroid: boolean;
+    isWeb: boolean;
+    isIOS: boolean;
+    pauseUI(): void;
+    resumeUI(): void;
+    isExistsShowStoryTextInput: boolean;
+    showStoryTextInput(id: string, data: Record<string, any>): void;
+    setStoryLocalData(keyValue: Record<string, any>, sendToServer: boolean): void;
+    getWidgetsSharedData<WidgetType extends keyof WidgetsSharedDataMap>(storyId: number, widget: Widgets): WidgetsSharedDataMap[WidgetType] | null;
+    vibrate(pattern: number): void;
+    openUrl(target: string): void;
+    sendApiRequest<ResponseDTO>(url: string, method: string, params: Record<string, any> | null, headers: Record<string, any> | null, data: Record<string, any> | null, profilingKey: string): Promise<APIResponse<ResponseDTO>>;
+    sendApiRequestSupported(): boolean;
+    showToast(text: string): void;
+    sdkCanSendShareComplete: boolean;
+    isExistsShare: boolean;
+    share(id: string, config: {
+        url?: string | null;
+        text?: string | null;
+        title?: string | null;
+        files?: Array<{
+            file: File;
+            name: string;
+            type: string;
+        }> | null;
+    }): void;
+    shareSlideScreenshot(shareId: string, hideElementsSelector?: string): void;
+    isExistsShowStorySlide: boolean;
+    showStorySlide(index: number): void;
+    isExistsShowNextStory: boolean;
+    storyShowNext(): void;
+}
+declare class WidgetsService {
+    private _env;
+    private _sdkApi;
+    constructor(_env: Window, _sdkApi: SDKApi);
+    get env(): Window;
+    get sdkApi(): SDKApi;
+}
+declare class WidgetBase<WidgetOptions extends WidgetOptionsBase> {
+    /**
+     * @see https://github.com/Microsoft/TypeScript/issues/3841#issuecomment-337560146
+     */
+    ["constructor"]: typeof WidgetBase;
+    static DEFAULTS: WidgetOptionsBase;
+    static widgetIndex: number;
+    protected env: Window;
+    protected sdkApi: SDKApi;
+    protected options: WidgetOptions;
+    protected element: HTMLElement;
+    protected elementId: string;
+    protected slide: HTMLElement;
+    protected slideIndex: number;
+    protected disableTimer: boolean;
+    protected layoutDirection: "ltr" | "rtl";
+    protected storyId: number;
+    protected widgetDone: Element | null;
+    protected showWidgetCompleteToast: boolean;
+    protected submitButtonAnimatedView: HTMLElement | null;
+    protected submitButtonView: HTMLElement | null;
+    protected submitButtonViewHeight: number;
+    protected savedData: Record<string, any> | null;
+    protected localData: Record<string, any>;
+    protected firstOpenTime: number;
+    protected id: string;
+    constructor(element: HTMLElement, options: Partial<WidgetOptions>, elementIdGetter?: (element: HTMLElement) => string, slideGetter?: (element: HTMLElement) => HTMLElement);
+    refreshUserData(localData: Record<string, any>): void;
+    static widgetCacheKey: string;
+    static widgetClassName: string;
+    static getInstance<Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(element: HTMLElement): Widget | undefined;
+    static getInstanceById<Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(id: string): Widget | undefined;
+    static createInstance<Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(instantiate: (element: HTMLElement, options: Partial<WidgetOptions>) => Widget, element: HTMLElement, options: Partial<WidgetOptions>): Widget;
+    static initWidgets<Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(instantiate: (element: HTMLElement, options: Partial<WidgetOptions>) => Widget, elements: Array<HTMLElement>, localData?: Record<string, any>): Promise<Record<string, any>>;
+    static get widgetsService(): WidgetsService;
+    static getLocalData(): Promise<Record<string, any>>;
+    getLocalData(): Promise<Record<string, any>>;
+    static setLocalData(keyValue: Record<string, any>, sendToServer?: boolean, syncWithRuntimeLocalData?: boolean): void;
+    setLocalData(keyValue: Record<string, any>, sendToServer?: boolean, syncWithRuntimeLocalData?: boolean): void;
+    static sendStatisticEventToApp(name: string, data: Record<string, string | number>, devPayload?: Record<string, string | number>): void;
+    sendStatisticEventToApp(name: string, data: Record<string, string | number>, devPayload?: Record<string, string | number>): void;
+    showNextSlide(): void;
+    protected _showLayout(layers: Array<HTMLElement>, selectIndex: number, withStatEvent?: boolean): void;
+    protected _statEventLayoutShow(layoutIndex: number): void;
+    static api: {
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions_1>, WidgetOptions_1 extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData: Record<string, any>) => void;
+    };
+}
+interface SDKInterface {
+    /**
+     * Return object from widgetsData._narrative_saved_data[storyId] or null
+     *
+     * Possible implementation
+     *         if ("_narrative_saved_data" in window && window._narrative_saved_data[storyId] != null && isObject(window._narrative_saved_data[storyId])) {
+     *             return window._narrative_saved_data[storyId];
+     *         }
+     */
+    getStoryServerData(storyId: number): Record<string, any> | null;
+    /**
+     * Return slide duration or null
+     *
+     * Possible implementation
+     *     if (
+     *         "_narrative_slides_duration" in window &&
+     *         window._narrative_slides_duration[storyId] != null &&
+     *         isArray(window._narrative_slides_duration[storyId]) &&
+     *         window._narrative_slides_duration[storyId][slideIndex] != null &&
+     *         isNumber(window._narrative_slides_duration[storyId][slideIndex])
+     *     ) {
+     *         return window._narrative_slides_duration[storyId][slideIndex];
+     *     }
+     */
+    getSlideDuration(storyId: number, slideIndex: number): number | null;
+    showNextSlide(duration: number): void;
+    /**
+     * From native sdk, do`t implement in web|react-sdk
+     */
+    sendStatisticEvent(name: string, data: Record<string, string | number>, devPayload?: Record<string, string | number>): void;
+    getStoryLocalData(): Promise<Record<string, any>>;
+    setStoryLocalData(keyValue: Record<string, any>, sendToServer: boolean): void;
+    showLayer(index: number): void;
+    /**
+     * Pause timer (story timeline), SlideApi used it on ShowTextInput appear
+     */
+    pauseUI(): void;
+    /**
+     * Resume timer (story timeline), SlideApi used it on ShowTextInput disappear
+     */
+    resumeUI(): void;
+    showStoryTextInput(id: string, data: Record<string, any>): void;
+    /**
+     * Possible implementation
+     *
+     * getWidgetsSharedData<WidgetType extends keyof WidgetsSharedDataMap>(storyId: number, widget: Widgets): WidgetsSharedDataMap[WidgetType] | null {
+     *         switch (widget) {
+     *             case Widgets.RangeSlider: {
+     *                 if ("_narrative_range_slider_data" in window && isObject(window._narrative_range_slider_data[storyId])) {
+     *                     return window._narrative_range_slider_data[storyId] as WidgetsSharedDataMap[WidgetType];
+     *                 }
+     *                 break;
+     *             }
+     *             case Widgets.Poll: {
+     *                 if ("_narrative_poll_data" in window && isObject(window._narrative_poll_data[storyId])) {
+     *                     return window._narrative_poll_data[storyId] as WidgetsSharedDataMap[WidgetType];
+     *                 }
+     *                 break;
+     *             }
+     *             case Widgets.Vote: {
+     *                 if ("_narrative_vote_data" in window && isObject(window._narrative_vote_data[storyId])) {
+     *                     return window._narrative_vote_data[storyId] as WidgetsSharedDataMap[WidgetType];
+     *                 }
+     *                 break;
+     *             }
+     *         }
+     *
+     *         return null;
+     *     }
+     */
+    getWidgetsSharedData<WidgetType extends keyof WidgetsSharedDataMap>(storyId: number, widget: Widgets): WidgetsSharedDataMap[WidgetType] | null;
+    /**
+     * Possible implementation
+     *
+     *     if ("_showNarrativeLink" in window) {
+     *         window._showNarrativeLink(target);
+     *     }
+     */
+    openUrl(target: string): void;
+    /**
+     * Possible implementation
+     *
+     * return window._sendApiRequest(url, method, params, headers, data, profilingKey);
+     */
+    sendApiRequest<ResponseDTO>(url: string, method: string, params: Record<string, any> | null, headers: Record<string, any> | null, data: Record<string, any> | null, profilingKey: string): Promise<APIResponse<ResponseDTO>>;
+    /**
+     * Possible implementation
+     *
+     * window._share(id, config);
+     */
+    share(id: string, config: {
+        url?: string | null;
+        text?: string | null;
+        title?: string | null;
+        files?: Array<{
+            file: File;
+            name: string;
+            type: string;
+        }> | null;
+    }): void;
+    /**
+     * Possible implementation
+     *
+     * window.share_slide_screenshot(shareId, hideElementsSelector);
+     */
+    shareSlideScreenshot(shareId: string, hideElementsSelector?: string): void;
+    /**
+     * Possible implementation
+     *
+     * window._showNarrativeSlide(index);
+     */
+    showStorySlide(index: number): void;
+    /**
+     * Possible implementation
+     *
+     * window._storyShowNext();
+     */
+    storyShowNext(): void;
+}
+declare let sdkInterface: SDKInterface;
+declare const getSlideApi: (_sdkInterface: SDKInterface) => {
+    Animation: IAnimation;
+    WidgetCopy: {
+        initWidget: (nodeList: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => void;
+        click: (element: HTMLElement) => boolean;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData: Record<string, any>) => void;
+    };
+    WidgetDataInput: {
+        initWidget: (nodeList: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => 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>) => void;
+    };
+    WidgetDateCountdown: {
+        initWidget: (nodeList: NodeListOf<HTMLElement>, layers: HTMLElement[], localData?: Record<string, any> | undefined) => 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>) => void;
+    };
+    WidgetMultiSlide: {
+        init: (slides: HTMLElement[], localData?: Record<string, any> | undefined) => void;
+    };
+    WidgetPoll: {
+        initWidget: (element: HTMLElement, localData?: Record<string, any> | undefined) => 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>) => void;
+    };
+    WidgetPollLayers: {
+        initWidget: (element: HTMLElement, layers: HTMLElement[], localData?: Record<string, any> | undefined) => void;
+        select: (element: HTMLElement) => boolean;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData: Record<string, any>) => void;
+    };
+    WidgetQuest: {
+        initWidget: (element: HTMLElement, localData?: Record<string, any> | undefined) => Promise<boolean>;
+        select: (element: HTMLElement) => boolean;
+        slideTestIsDone: (element: HTMLElement) => boolean;
+        handleRouteClick: (element: HTMLElement, event: {
+            direction: "forward" | "backward";
+            slideIndex: number;
+            slideCount: number;
+            click: () => void;
+        }) => void;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData: Record<string, any>) => void;
+    };
+    WidgetQuiz: {
+        initWidget: (element: HTMLElement, localData?: Record<string, any> | undefined) => void;
+        select: (element: HTMLElement) => boolean;
+        slideQuizIsDone: (element: HTMLElement) => boolean;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData: Record<string, any>) => void;
+    };
+    WidgetQuizGrouped: {
+        initWidget: (element: HTMLElement, localData?: Record<string, any> | undefined) => void;
+        select: (element: HTMLElement) => boolean;
+        slideQuizIsDone: (element: HTMLElement) => boolean;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData: Record<string, any>) => void;
+    };
+    WidgetRangeSlider: {
+        initWidget: (element: HTMLElement, localData?: Record<string, any> | undefined) => void;
+        click: (element: HTMLElement) => boolean;
+        isClickCapturedBySlider: (element: HTMLElement) => boolean;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData: Record<string, any>) => void;
+    };
+    WidgetRate: {
+        initWidget: (nodeList: NodeListOf<HTMLElement>, localData?: Record<string, any> | undefined) => 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>) => void;
+    };
+    WidgetShare: {
+        initWidget: (nodeList: NodeListOf<HTMLElement>, layers: HTMLElement[], localData?: Record<string, any> | undefined) => 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>) => void;
+    };
+    WidgetTest: {
+        initWidget: (element: HTMLElement, localData?: Record<string, any> | undefined) => 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>) => void;
+    };
+    WidgetVote: {
+        fallbackInitOnMultiSlide: (element: HTMLElement, localData?: Record<string, any> | undefined) => void;
+        initWidget: (element: HTMLElement, localData?: Record<string, any> | undefined) => void;
+        select: (element: HTMLElement) => boolean;
+        slideVoteIsDone: (element: HTMLElement) => boolean;
+        refreshUserData: <Widget extends WidgetBase<WidgetOptions>, WidgetOptions extends WidgetOptionsBase>(nodes: NodeListOf<HTMLElement>, localData: Record<string, any>) => void;
+    };
+};
+export { sdkInterface, getSlideApi };