@inappstory/slide-api 0.1.49 → 0.1.51

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 import { Player } from '@inappstory/video-player';
+import { EventEmitter } from 'events';
 
 declare const enum CARD_TYPE {
     STORY = 1,
@@ -233,6 +234,7 @@ declare class WidgetDataInput extends WidgetBase<WidgetDataInputOptions> {
         activateAfterCreate: boolean;
         create: boolean;
         localData: {};
+        layers: never[];
     };
     static widgetClassName: string;
     private readonly label;
@@ -240,6 +242,8 @@ declare class WidgetDataInput extends WidgetBase<WidgetDataInputOptions> {
     private readonly inputElement;
     private readonly textElement;
     private readonly inputPlaceholderValue;
+    private readonly layers;
+    private readonly actionAfterCompletion;
     /**
      * @throws Error
      * @param element
@@ -260,10 +264,14 @@ declare class WidgetDataInput extends WidgetBase<WidgetDataInputOptions> {
     click(element: HTMLElement): boolean;
     private _fillUserText;
     setUserText(text: string): void;
+    private doCompletitionAction;
+    private doCompletitionActionOnRefreshUserData;
+    private showNotification;
+    private showLayer;
     static api: {
         widgetClassName: string;
         onRefreshUserData: typeof WidgetBase.onRefreshUserData;
-        init: (element: HTMLElement, localData: Record<string, any>, widgetCallbacks: WidgetCallbacks, widgetDeps: WidgetDeps) => void;
+        init: (element: HTMLElement, layers: Array<HTMLElement>, localData: Record<string, any>, widgetCallbacks: WidgetCallbacks, widgetDeps: WidgetDeps) => void;
         onStart: (element: HTMLElement) => void;
         onStop: (element: HTMLElement) => void;
         click: (element: HTMLElement) => boolean;
@@ -481,6 +489,8 @@ declare class WidgetProducts extends WidgetBase<WidgetProductsOptions> {
     closeProductsView(): void;
     private createCardView;
     private showProductDetails;
+    private statEventGoToCart;
+    private statEventAddToCart;
     private createScrollView;
     private createProductsView;
     private scrollViewRef;
@@ -557,6 +567,9 @@ declare class WidgetProductCarousel extends WidgetBase<WidgetProductCarouselOpti
     private addToCart;
     private getBottomSheetParams;
     private statEventWidgetCardClick;
+    private statEventClickPurchaseButton;
+    private statEventAddToCart;
+    private statEventGoToCart;
     private isCartSupported;
     private disableHostUIInteraction;
     private enableHostUIInteraction;
@@ -1837,6 +1850,7 @@ interface IElement {
     onStop(): void;
     onStart(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     isLayerForcePaused: boolean;
     mediaElementsLoadingPromises: Array<Promise<HTMLImageElement | HTMLVideoElement>>;
@@ -1845,12 +1859,13 @@ interface IElement {
 declare class DataInput implements IElement {
     private readonly _elementNodeRef;
     private readonly _layer;
+    private readonly _layersNodesRefs;
     private readonly _widgetApi;
     private readonly _widgetCallbacks;
     private readonly _widgetDeps;
     private static readonly _className;
     static className(): string;
-    constructor(_elementNodeRef: HTMLElement, _layer: Layer, _widgetApi: typeof WidgetDataInput.api, _widgetCallbacks: WidgetCallbacks, _widgetDeps: WidgetDeps);
+    constructor(_elementNodeRef: HTMLElement, _layer: Layer, _layersNodesRefs: Array<HTMLElement>, _widgetApi: typeof WidgetDataInput.api, _widgetCallbacks: WidgetCallbacks, _widgetDeps: WidgetDeps);
     static isTypeOf(element: IElement): element is DataInput;
     mediaElementsLoadingPromises: Array<Promise<HTMLImageElement | HTMLVideoElement>>;
     get nodeRef(): HTMLElement;
@@ -1860,6 +1875,7 @@ declare class DataInput implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     setUserData(id: string, text: string): void;
     get isLayerForcePaused(): boolean;
@@ -1883,6 +1899,7 @@ declare class Poll implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     setUserData(id: string, text: string): void;
     get isLayerForcePaused(): boolean;
@@ -1907,6 +1924,7 @@ declare class PollLayers implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get isLayerForcePaused(): boolean;
 }
@@ -1929,6 +1947,7 @@ declare class Products implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     handleBackpress(): void;
     get elementNodeRef(): HTMLElement;
@@ -1954,6 +1973,7 @@ declare class ProductCarousel implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get isClickCapturedByWidget(): boolean;
     get isLayerForcePaused(): boolean;
@@ -1978,6 +1998,7 @@ declare class Quest implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     handleRouteClick(options: {
         direction: "backward" | "forward";
@@ -2007,6 +2028,7 @@ declare class Quiz implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get slideQuizIsDone(): boolean;
     get isLayerForcePaused(): boolean;
@@ -2030,6 +2052,7 @@ declare class QuizGrouped implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get slideQuizGroupedIsDone(): boolean;
     get isLayerForcePaused(): boolean;
@@ -2053,9 +2076,10 @@ declare class RangeSlider implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
-    get isClickCapturedBySlider(): boolean;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get isLayerForcePaused(): boolean;
+    get isClickCapturedBySlider(): boolean;
 }
 
 declare class Rate implements IElement {
@@ -2076,6 +2100,7 @@ declare class Rate implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     setUserData(id: string, text: string): void;
     get isLayerForcePaused(): boolean;
@@ -2101,6 +2126,7 @@ declare class Share implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     complete(id: string, isSuccess: boolean): void;
     get isLayerForcePaused(): boolean;
@@ -2121,6 +2147,7 @@ declare class SwipeUp implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get elementNodeRef(): HTMLElement;
     get isLayerForcePaused(): boolean;
@@ -2141,6 +2168,7 @@ declare class SwipeUpItems implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get elementNodeRef(): HTMLElement;
     get isLayerForcePaused(): boolean;
@@ -2164,6 +2192,7 @@ declare class Test implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get slideTestIsDone(): boolean;
     get slideTestWithTimer(): boolean;
@@ -2192,6 +2221,7 @@ declare class Video implements IElement {
     onResume(): void;
     onStart(): void;
     onStop(): void;
+    onRefreshUserData(localData: Record<string, any>): void;
     onBeforeUnmount(): Promise<void>;
     get durationMs(): number;
     private _initVOD;
@@ -2276,6 +2306,7 @@ declare class ScratchCard implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get isLayerForcePaused(): boolean;
     get isClickCaptured(): boolean;
@@ -2286,7 +2317,7 @@ declare const enum ON_SLIDE_STOP_PREPARE_FOR_RESTART {
     PREPARE = 1,
     NOT_PREPARE = 2
 }
-declare class Layer {
+declare class Layer extends EventEmitter {
     private readonly _nodeRef;
     private readonly _slide;
     private readonly _layerIndex;
@@ -2310,9 +2341,10 @@ declare class Layer {
     private readonly _scrollView;
     private _layerVerticalScrollNotifier;
     private _elements;
-    private readonly _timeline;
+    private _timeline;
     private readonly _widgetDeps;
     constructor(_nodeRef: HTMLElement, _slide: Slide, _layerIndex: number, _slideReadyPromise: Promise<void>, _afterAppResumeQueuePush: (cb: () => void) => void, _afterStartInitQueuePush: (cb: () => void) => void, slideApiDeps: ISlideApiDeps, _slideRoot: HTMLElement, _getLayoutDirection: () => "ltr" | "rtl", _slidePauseUI: () => Promise<void>, _slideResumeUI: () => Promise<void>, _getSdkClientVariables: GetSdkClientVariables);
+    initTimeline(): void;
     init(localData: LocalData): Array<Promise<boolean>>;
     onUpdateSizeMetrics(metrics: SizeMetrics): void;
     onAfterAllMediaResourcesLoaded(): void;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { Player } from '@inappstory/video-player';
+import { EventEmitter } from 'events';
 
 declare const enum CARD_TYPE {
     STORY = 1,
@@ -233,6 +234,7 @@ declare class WidgetDataInput extends WidgetBase<WidgetDataInputOptions> {
         activateAfterCreate: boolean;
         create: boolean;
         localData: {};
+        layers: never[];
     };
     static widgetClassName: string;
     private readonly label;
@@ -240,6 +242,8 @@ declare class WidgetDataInput extends WidgetBase<WidgetDataInputOptions> {
     private readonly inputElement;
     private readonly textElement;
     private readonly inputPlaceholderValue;
+    private readonly layers;
+    private readonly actionAfterCompletion;
     /**
      * @throws Error
      * @param element
@@ -260,10 +264,14 @@ declare class WidgetDataInput extends WidgetBase<WidgetDataInputOptions> {
     click(element: HTMLElement): boolean;
     private _fillUserText;
     setUserText(text: string): void;
+    private doCompletitionAction;
+    private doCompletitionActionOnRefreshUserData;
+    private showNotification;
+    private showLayer;
     static api: {
         widgetClassName: string;
         onRefreshUserData: typeof WidgetBase.onRefreshUserData;
-        init: (element: HTMLElement, localData: Record<string, any>, widgetCallbacks: WidgetCallbacks, widgetDeps: WidgetDeps) => void;
+        init: (element: HTMLElement, layers: Array<HTMLElement>, localData: Record<string, any>, widgetCallbacks: WidgetCallbacks, widgetDeps: WidgetDeps) => void;
         onStart: (element: HTMLElement) => void;
         onStop: (element: HTMLElement) => void;
         click: (element: HTMLElement) => boolean;
@@ -481,6 +489,8 @@ declare class WidgetProducts extends WidgetBase<WidgetProductsOptions> {
     closeProductsView(): void;
     private createCardView;
     private showProductDetails;
+    private statEventGoToCart;
+    private statEventAddToCart;
     private createScrollView;
     private createProductsView;
     private scrollViewRef;
@@ -557,6 +567,9 @@ declare class WidgetProductCarousel extends WidgetBase<WidgetProductCarouselOpti
     private addToCart;
     private getBottomSheetParams;
     private statEventWidgetCardClick;
+    private statEventClickPurchaseButton;
+    private statEventAddToCart;
+    private statEventGoToCart;
     private isCartSupported;
     private disableHostUIInteraction;
     private enableHostUIInteraction;
@@ -1837,6 +1850,7 @@ interface IElement {
     onStop(): void;
     onStart(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     isLayerForcePaused: boolean;
     mediaElementsLoadingPromises: Array<Promise<HTMLImageElement | HTMLVideoElement>>;
@@ -1845,12 +1859,13 @@ interface IElement {
 declare class DataInput implements IElement {
     private readonly _elementNodeRef;
     private readonly _layer;
+    private readonly _layersNodesRefs;
     private readonly _widgetApi;
     private readonly _widgetCallbacks;
     private readonly _widgetDeps;
     private static readonly _className;
     static className(): string;
-    constructor(_elementNodeRef: HTMLElement, _layer: Layer, _widgetApi: typeof WidgetDataInput.api, _widgetCallbacks: WidgetCallbacks, _widgetDeps: WidgetDeps);
+    constructor(_elementNodeRef: HTMLElement, _layer: Layer, _layersNodesRefs: Array<HTMLElement>, _widgetApi: typeof WidgetDataInput.api, _widgetCallbacks: WidgetCallbacks, _widgetDeps: WidgetDeps);
     static isTypeOf(element: IElement): element is DataInput;
     mediaElementsLoadingPromises: Array<Promise<HTMLImageElement | HTMLVideoElement>>;
     get nodeRef(): HTMLElement;
@@ -1860,6 +1875,7 @@ declare class DataInput implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     setUserData(id: string, text: string): void;
     get isLayerForcePaused(): boolean;
@@ -1883,6 +1899,7 @@ declare class Poll implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     setUserData(id: string, text: string): void;
     get isLayerForcePaused(): boolean;
@@ -1907,6 +1924,7 @@ declare class PollLayers implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get isLayerForcePaused(): boolean;
 }
@@ -1929,6 +1947,7 @@ declare class Products implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     handleBackpress(): void;
     get elementNodeRef(): HTMLElement;
@@ -1954,6 +1973,7 @@ declare class ProductCarousel implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get isClickCapturedByWidget(): boolean;
     get isLayerForcePaused(): boolean;
@@ -1978,6 +1998,7 @@ declare class Quest implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     handleRouteClick(options: {
         direction: "backward" | "forward";
@@ -2007,6 +2028,7 @@ declare class Quiz implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get slideQuizIsDone(): boolean;
     get isLayerForcePaused(): boolean;
@@ -2030,6 +2052,7 @@ declare class QuizGrouped implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get slideQuizGroupedIsDone(): boolean;
     get isLayerForcePaused(): boolean;
@@ -2053,9 +2076,10 @@ declare class RangeSlider implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
-    get isClickCapturedBySlider(): boolean;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get isLayerForcePaused(): boolean;
+    get isClickCapturedBySlider(): boolean;
 }
 
 declare class Rate implements IElement {
@@ -2076,6 +2100,7 @@ declare class Rate implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     setUserData(id: string, text: string): void;
     get isLayerForcePaused(): boolean;
@@ -2101,6 +2126,7 @@ declare class Share implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     complete(id: string, isSuccess: boolean): void;
     get isLayerForcePaused(): boolean;
@@ -2121,6 +2147,7 @@ declare class SwipeUp implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get elementNodeRef(): HTMLElement;
     get isLayerForcePaused(): boolean;
@@ -2141,6 +2168,7 @@ declare class SwipeUpItems implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get elementNodeRef(): HTMLElement;
     get isLayerForcePaused(): boolean;
@@ -2164,6 +2192,7 @@ declare class Test implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get slideTestIsDone(): boolean;
     get slideTestWithTimer(): boolean;
@@ -2192,6 +2221,7 @@ declare class Video implements IElement {
     onResume(): void;
     onStart(): void;
     onStop(): void;
+    onRefreshUserData(localData: Record<string, any>): void;
     onBeforeUnmount(): Promise<void>;
     get durationMs(): number;
     private _initVOD;
@@ -2276,6 +2306,7 @@ declare class ScratchCard implements IElement {
     onStart(): void;
     onStop(): void;
     onBeforeUnmount(): Promise<void>;
+    onRefreshUserData(localData: Record<string, any>): void;
     handleClick(): boolean;
     get isLayerForcePaused(): boolean;
     get isClickCaptured(): boolean;
@@ -2286,7 +2317,7 @@ declare const enum ON_SLIDE_STOP_PREPARE_FOR_RESTART {
     PREPARE = 1,
     NOT_PREPARE = 2
 }
-declare class Layer {
+declare class Layer extends EventEmitter {
     private readonly _nodeRef;
     private readonly _slide;
     private readonly _layerIndex;
@@ -2310,9 +2341,10 @@ declare class Layer {
     private readonly _scrollView;
     private _layerVerticalScrollNotifier;
     private _elements;
-    private readonly _timeline;
+    private _timeline;
     private readonly _widgetDeps;
     constructor(_nodeRef: HTMLElement, _slide: Slide, _layerIndex: number, _slideReadyPromise: Promise<void>, _afterAppResumeQueuePush: (cb: () => void) => void, _afterStartInitQueuePush: (cb: () => void) => void, slideApiDeps: ISlideApiDeps, _slideRoot: HTMLElement, _getLayoutDirection: () => "ltr" | "rtl", _slidePauseUI: () => Promise<void>, _slideResumeUI: () => Promise<void>, _getSdkClientVariables: GetSdkClientVariables);
+    initTimeline(): void;
     init(localData: LocalData): Array<Promise<boolean>>;
     onUpdateSizeMetrics(metrics: SizeMetrics): void;
     onAfterAllMediaResourcesLoaded(): void;