@inappstory/slide-api 0.1.44 → 0.1.46

package/dist/index.d.cts

@@ -1168,12 +1168,11 @@ declare class Toast {
 }
 declare global {
     interface Window {
-        _narrative_saved_data: Record<number, Record<string, any>>;
-        _narrative_slides_duration: Record<number, Record<number, number>>;
-        _narrative_range_slider_data: Record<number, WidgetRangeSliderSharedData>;
-        _narrative_poll_data: Record<number, WidgetPollSharedData>;
-        _narrative_vote_data: Record<number, WidgetVoteSharedData>;
-        _narrative_reactions_data: Record<number, WidgetReactionsSharedData>;
+        _narrative_saved_data: Record<string, any>;
+        _narrative_range_slider_data: WidgetRangeSliderSharedData;
+        _narrative_poll_data: WidgetPollSharedData;
+        _narrative_vote_data: WidgetVoteSharedData;
+        _narrative_reactions_data: WidgetReactionsSharedData;
         _showNarrativeNextSlide(duration: number): void;
         _sendStatisticEvent(name: string, data: Record<string, string | number | Array<string | number>>, devPayload?: Record<string, string | number | Array<string | number>>, forceEnableStatisticV2?: boolean): void;
         _getNarrativeLocalData(): Promise<Record<string, any>>;
@@ -1274,6 +1273,14 @@ declare global {
         }) => void;
         _onEvent<K extends keyof EventHandlersEventMap>(name: K, event: EventHandlersEventMap[K]): void;
         _onCardLoadingStateChange(state: CARD_LOADING_STATE, reason?: string): void;
+        _onVerticalScrollChange(data: {
+            scrollY: number;
+            scrollPercent: number;
+            isScrollableLayer: boolean;
+            cardId: number;
+            slideIndex: number;
+            layerIndex: number;
+        }): void;
         _promiseApiQueue: Map<string, {
             onSuccess: (value: any) => void;
             onError: (reason?: any) => void;
@@ -1360,8 +1367,8 @@ type FontDTO = {
     weight: string;
 };
 interface SDKApi {
-    getCardServerData(cardId: number): Record<string, any> | null;
-    updateCardServerDataLocally(cardId: number, data: Record<string, any>): void;
+    getCardServerData(): Record<string, any> | null;
+    updateCardServerDataLocally(data: Record<string, any>): void;
     showNextSlide(duration: number): void;
     sendStatisticEvent(name: string, data: Record<string, string | number | Array<string | number>>, devPayload?: Record<string, string | number | Array<string | number>>, forceEnableStatisticV2?: boolean): void;
     getCardLocalData(): Promise<Record<string, any>>;
@@ -1374,7 +1381,7 @@ interface SDKApi {
     isExistsShowCardTextInput: boolean;
     showCardTextInput(id: string, data: Record<string, any>): void;
     setCardLocalData(keyValue: Record<string, any>, sendToServer: boolean): void;
-    getWidgetsSharedData<WidgetType extends keyof WidgetsSharedDataMap>(cardId: number, widget: Widgets): WidgetsSharedDataMap[WidgetType] | null;
+    getWidgetsSharedData<WidgetType extends keyof WidgetsSharedDataMap>(widget: Widgets): WidgetsSharedDataMap[WidgetType] | null;
     vibrate(pattern: number): void;
     openUrl(data: {
         type: "link" | "swipeUpLink" | "swipeUpItems";
@@ -1439,6 +1446,14 @@ interface SDKApi {
     productCartClicked(): void;
     onWidgetRequirePauseUI(): void;
     onWidgetRequireResumeUI(): void;
+    onVerticalScrollChange(data: {
+        scrollY: number;
+        scrollPercent: number;
+        isScrollableLayer: boolean;
+        cardId: number;
+        slideIndex: number;
+        layerIndex: number;
+    }): void;
 }
 
 interface ISlideApiDeps {
@@ -1497,6 +1512,7 @@ interface ISlideApiDeps {
     productCartClicked: SDKApi["productCartClicked"];
     onWidgetRequirePauseUI: SDKApi["onWidgetRequirePauseUI"];
     onWidgetRequireResumeUI: SDKApi["onWidgetRequireResumeUI"];
+    onVerticalScrollChange: SDKApi["onVerticalScrollChange"];
 }
 
 type WidgetOptionsBase = {
@@ -1644,7 +1660,7 @@ interface SDKInterface {
      *             return window._narrative_saved_data[cardId];
      *         }
      */
-    getCardServerData(cardId: number): Record<string, any> | null;
+    getCardServerData(): Record<string, any> | null;
     updateCardServerDataLocally(data: Record<string, any>): void;
     showNextSlide(): void;
     /**
@@ -1683,7 +1699,7 @@ interface SDKInterface {
      *         return null;
      *     }
      */
-    getWidgetsSharedData<WidgetType extends keyof WidgetsSharedDataMap>(cardId: number, widget: Widgets): WidgetsSharedDataMap[WidgetType] | null;
+    getWidgetsSharedData<WidgetType extends keyof WidgetsSharedDataMap>(widget: Widgets): WidgetsSharedDataMap[WidgetType] | null;
     /**
      * Possible implementation
      *
@@ -1794,6 +1810,14 @@ interface SDKInterface {
     productCartClicked(): void;
     onWidgetRequirePauseUI(): void;
     onWidgetRequireResumeUI(): void;
+    onVerticalScrollChange(data: {
+        scrollY: number;
+        scrollPercent: number;
+        isScrollableLayer: boolean;
+        cardId: number;
+        slideIndex: number;
+        layerIndex: number;
+    }): void;
 }
 
 type LocalData = Record<string, any>;
@@ -2193,6 +2217,14 @@ declare class Video implements IElement {
     disableAudio(): void;
 }
 
+type SizeMetrics = {
+    fontSize: string;
+    xOffset: string;
+    yOffset: string;
+    slideOffsetMargin: string;
+    isFullscreen: boolean;
+};
+
 declare class Slide {
     private readonly _slidesNodesRefs;
     private readonly _slideReadyPromise;
@@ -2207,6 +2239,7 @@ declare class Slide {
     private readonly _layers;
     private _start;
     constructor(_slidesNodesRefs: Array<HTMLElement>, _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);
+    onUpdateSizeMetrics(metrics: SizeMetrics): void;
     private _activeLayer;
     get activeLayer(): Layer;
     get layers(): Array<Layer>;
@@ -2255,6 +2288,7 @@ declare const enum ON_SLIDE_STOP_PREPARE_FOR_RESTART {
 declare class Layer {
     private readonly _nodeRef;
     private readonly _slide;
+    private readonly _layerIndex;
     private readonly _slideReadyPromise;
     private readonly _afterAppResumeQueuePush;
     private readonly _afterStartInitQueuePush;
@@ -2271,11 +2305,15 @@ declare class Layer {
     private readonly _duration;
     private readonly _disabledTimer;
     private readonly _disabledNavigation;
+    private readonly _scrollable;
+    private readonly _scrollView;
+    private _layerVerticalScrollNotifier;
     private _elements;
     private readonly _timeline;
     private readonly _widgetDeps;
-    constructor(_nodeRef: HTMLElement, _slide: Slide, _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);
+    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);
     init(localData: LocalData): Array<Promise<boolean>>;
+    onUpdateSizeMetrics(metrics: SizeMetrics): void;
     onAfterAllMediaResourcesLoaded(): void;
     get nodeRef(): HTMLElement;
     get elements(): Array<IElement>;
@@ -2292,6 +2330,7 @@ declare class Layer {
     get cardType(): CARD_TYPE;
     get slideCount(): number;
     get disabledNavigation(): boolean;
+    get scrollable(): boolean;
     get videoElement(): Video | null;
     get rangeSliderElement(): RangeSlider | null;
     get scratchCardElements(): ScratchCard[];

package/dist/index.d.ts

@@ -1168,12 +1168,11 @@ declare class Toast {
 }
 declare global {
     interface Window {
-        _narrative_saved_data: Record<number, Record<string, any>>;
-        _narrative_slides_duration: Record<number, Record<number, number>>;
-        _narrative_range_slider_data: Record<number, WidgetRangeSliderSharedData>;
-        _narrative_poll_data: Record<number, WidgetPollSharedData>;
-        _narrative_vote_data: Record<number, WidgetVoteSharedData>;
-        _narrative_reactions_data: Record<number, WidgetReactionsSharedData>;
+        _narrative_saved_data: Record<string, any>;
+        _narrative_range_slider_data: WidgetRangeSliderSharedData;
+        _narrative_poll_data: WidgetPollSharedData;
+        _narrative_vote_data: WidgetVoteSharedData;
+        _narrative_reactions_data: WidgetReactionsSharedData;
         _showNarrativeNextSlide(duration: number): void;
         _sendStatisticEvent(name: string, data: Record<string, string | number | Array<string | number>>, devPayload?: Record<string, string | number | Array<string | number>>, forceEnableStatisticV2?: boolean): void;
         _getNarrativeLocalData(): Promise<Record<string, any>>;
@@ -1274,6 +1273,14 @@ declare global {
         }) => void;
         _onEvent<K extends keyof EventHandlersEventMap>(name: K, event: EventHandlersEventMap[K]): void;
         _onCardLoadingStateChange(state: CARD_LOADING_STATE, reason?: string): void;
+        _onVerticalScrollChange(data: {
+            scrollY: number;
+            scrollPercent: number;
+            isScrollableLayer: boolean;
+            cardId: number;
+            slideIndex: number;
+            layerIndex: number;
+        }): void;
         _promiseApiQueue: Map<string, {
             onSuccess: (value: any) => void;
             onError: (reason?: any) => void;
@@ -1360,8 +1367,8 @@ type FontDTO = {
     weight: string;
 };
 interface SDKApi {
-    getCardServerData(cardId: number): Record<string, any> | null;
-    updateCardServerDataLocally(cardId: number, data: Record<string, any>): void;
+    getCardServerData(): Record<string, any> | null;
+    updateCardServerDataLocally(data: Record<string, any>): void;
     showNextSlide(duration: number): void;
     sendStatisticEvent(name: string, data: Record<string, string | number | Array<string | number>>, devPayload?: Record<string, string | number | Array<string | number>>, forceEnableStatisticV2?: boolean): void;
     getCardLocalData(): Promise<Record<string, any>>;
@@ -1374,7 +1381,7 @@ interface SDKApi {
     isExistsShowCardTextInput: boolean;
     showCardTextInput(id: string, data: Record<string, any>): void;
     setCardLocalData(keyValue: Record<string, any>, sendToServer: boolean): void;
-    getWidgetsSharedData<WidgetType extends keyof WidgetsSharedDataMap>(cardId: number, widget: Widgets): WidgetsSharedDataMap[WidgetType] | null;
+    getWidgetsSharedData<WidgetType extends keyof WidgetsSharedDataMap>(widget: Widgets): WidgetsSharedDataMap[WidgetType] | null;
     vibrate(pattern: number): void;
     openUrl(data: {
         type: "link" | "swipeUpLink" | "swipeUpItems";
@@ -1439,6 +1446,14 @@ interface SDKApi {
     productCartClicked(): void;
     onWidgetRequirePauseUI(): void;
     onWidgetRequireResumeUI(): void;
+    onVerticalScrollChange(data: {
+        scrollY: number;
+        scrollPercent: number;
+        isScrollableLayer: boolean;
+        cardId: number;
+        slideIndex: number;
+        layerIndex: number;
+    }): void;
 }
 
 interface ISlideApiDeps {
@@ -1497,6 +1512,7 @@ interface ISlideApiDeps {
     productCartClicked: SDKApi["productCartClicked"];
     onWidgetRequirePauseUI: SDKApi["onWidgetRequirePauseUI"];
     onWidgetRequireResumeUI: SDKApi["onWidgetRequireResumeUI"];
+    onVerticalScrollChange: SDKApi["onVerticalScrollChange"];
 }
 
 type WidgetOptionsBase = {
@@ -1644,7 +1660,7 @@ interface SDKInterface {
      *             return window._narrative_saved_data[cardId];
      *         }
      */
-    getCardServerData(cardId: number): Record<string, any> | null;
+    getCardServerData(): Record<string, any> | null;
     updateCardServerDataLocally(data: Record<string, any>): void;
     showNextSlide(): void;
     /**
@@ -1683,7 +1699,7 @@ interface SDKInterface {
      *         return null;
      *     }
      */
-    getWidgetsSharedData<WidgetType extends keyof WidgetsSharedDataMap>(cardId: number, widget: Widgets): WidgetsSharedDataMap[WidgetType] | null;
+    getWidgetsSharedData<WidgetType extends keyof WidgetsSharedDataMap>(widget: Widgets): WidgetsSharedDataMap[WidgetType] | null;
     /**
      * Possible implementation
      *
@@ -1794,6 +1810,14 @@ interface SDKInterface {
     productCartClicked(): void;
     onWidgetRequirePauseUI(): void;
     onWidgetRequireResumeUI(): void;
+    onVerticalScrollChange(data: {
+        scrollY: number;
+        scrollPercent: number;
+        isScrollableLayer: boolean;
+        cardId: number;
+        slideIndex: number;
+        layerIndex: number;
+    }): void;
 }
 
 type LocalData = Record<string, any>;
@@ -2193,6 +2217,14 @@ declare class Video implements IElement {
     disableAudio(): void;
 }
 
+type SizeMetrics = {
+    fontSize: string;
+    xOffset: string;
+    yOffset: string;
+    slideOffsetMargin: string;
+    isFullscreen: boolean;
+};
+
 declare class Slide {
     private readonly _slidesNodesRefs;
     private readonly _slideReadyPromise;
@@ -2207,6 +2239,7 @@ declare class Slide {
     private readonly _layers;
     private _start;
     constructor(_slidesNodesRefs: Array<HTMLElement>, _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);
+    onUpdateSizeMetrics(metrics: SizeMetrics): void;
     private _activeLayer;
     get activeLayer(): Layer;
     get layers(): Array<Layer>;
@@ -2255,6 +2288,7 @@ declare const enum ON_SLIDE_STOP_PREPARE_FOR_RESTART {
 declare class Layer {
     private readonly _nodeRef;
     private readonly _slide;
+    private readonly _layerIndex;
     private readonly _slideReadyPromise;
     private readonly _afterAppResumeQueuePush;
     private readonly _afterStartInitQueuePush;
@@ -2271,11 +2305,15 @@ declare class Layer {
     private readonly _duration;
     private readonly _disabledTimer;
     private readonly _disabledNavigation;
+    private readonly _scrollable;
+    private readonly _scrollView;
+    private _layerVerticalScrollNotifier;
     private _elements;
     private readonly _timeline;
     private readonly _widgetDeps;
-    constructor(_nodeRef: HTMLElement, _slide: Slide, _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);
+    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);
     init(localData: LocalData): Array<Promise<boolean>>;
+    onUpdateSizeMetrics(metrics: SizeMetrics): void;
     onAfterAllMediaResourcesLoaded(): void;
     get nodeRef(): HTMLElement;
     get elements(): Array<IElement>;
@@ -2292,6 +2330,7 @@ declare class Layer {
     get cardType(): CARD_TYPE;
     get slideCount(): number;
     get disabledNavigation(): boolean;
+    get scrollable(): boolean;
     get videoElement(): Video | null;
     get rangeSliderElement(): RangeSlider | null;
     get scratchCardElements(): ScratchCard[];