@inappstory/slide-api 0.1.8 → 0.1.9

package/dist/index.d.cts

@@ -817,9 +817,9 @@ declare class SlideTimeline {
     private readonly slideDuration;
     private readonly slideDisabledTimer;
     private readonly slideReady;
-    private readonly _afterResumeQueuePush;
+    private readonly _afterAppResumeQueuePush;
     private readonly sdkApi;
-    constructor(slideIndex: number, slideDuration: number, slideDisabledTimer: boolean, slideReady: Promise<void>, _afterResumeQueuePush: (cb: () => void) => void, sdkApi: SDKApi);
+    constructor(slideIndex: number, slideDuration: number, slideDisabledTimer: boolean, slideReady: Promise<void>, _afterAppResumeQueuePush: (cb: () => void) => void, sdkApi: SDKApi);
     private resumedAt;
     private timeSpent;
     private timelineDisabledState;
@@ -1559,13 +1559,13 @@ declare class Video implements IElement {
 declare class Slide {
     private readonly _slidesNodesRefs;
     private readonly _slideReadyPromise;
-    private readonly _afterResumeQueuePush;
+    private readonly _afterAppResumeQueuePush;
     private readonly _afterStartInitQueuePush;
     private readonly _showNextSlide;
     readonly sdkApi: SDKApi;
     private readonly _layers;
     private _start;
-    constructor(_slidesNodesRefs: Array<HTMLElement>, _slideReadyPromise: Promise<void>, _afterResumeQueuePush: (cb: () => void) => void, _afterStartInitQueuePush: (cb: () => void) => void, _showNextSlide: (duration: number) => void, sdkApi: SDKApi);
+    constructor(_slidesNodesRefs: Array<HTMLElement>, _slideReadyPromise: Promise<void>, _afterAppResumeQueuePush: (cb: () => void) => void, _afterStartInitQueuePush: (cb: () => void) => void, _showNextSlide: (duration: number) => void, sdkApi: SDKApi);
     private _activeLayer;
     get activeLayer(): Layer;
     get layers(): Array<Layer>;
@@ -1591,7 +1591,7 @@ declare class Layer {
     private readonly _nodeRef;
     private readonly _slide;
     private readonly _slideReadyPromise;
-    private readonly _afterResumeQueuePush;
+    private readonly _afterAppResumeQueuePush;
     private readonly _afterStartInitQueuePush;
     private readonly _showNextSlide;
     readonly sdkApi: SDKApi;
@@ -1604,7 +1604,7 @@ declare class Layer {
     private readonly _disabledNavigation;
     private _elements;
     private readonly _timeline;
-    constructor(_nodeRef: HTMLElement, _slide: Slide, _slideReadyPromise: Promise<void>, _afterResumeQueuePush: (cb: () => void) => void, _afterStartInitQueuePush: (cb: () => void) => void, _showNextSlide: (duration: number) => void, sdkApi: SDKApi);
+    constructor(_nodeRef: HTMLElement, _slide: Slide, _slideReadyPromise: Promise<void>, _afterAppResumeQueuePush: (cb: () => void) => void, _afterStartInitQueuePush: (cb: () => void) => void, _showNextSlide: (duration: number) => void, sdkApi: SDKApi);
     init(localData: LocalData): Array<Promise<boolean>>;
     get nodeRef(): HTMLElement;
     get elements(): Array<IElement>;
@@ -1646,7 +1646,7 @@ declare class Layer {
     stopInternal(options: {
         prepareForRestart: ON_SLIDE_STOP_PREPARE_FOR_RESTART;
     }): void;
-    pause(resetVideoTime?: boolean, stopAnimation?: boolean): Promise<{
+    pause(resetVideoTime?: boolean, stopAnimation?: boolean, updateTimeline?: boolean): Promise<{
         currentTime: number | null;
     }>;
     resume(): Promise<unknown>;
@@ -1662,11 +1662,14 @@ declare const enum STATE {
     STARTED = 3,
     RESUME = 4,
     RESUMED = 5,
-    PAUSE = 6,
-    PAUSED = 7,
-    FORCE_PAUSED = 8,
-    STOP = 9,
-    STOPPED = 10
+    APP_PAUSE = 6,
+    APP_PAUSED = 7,
+    USER_PAUSE = 8,
+    USER_PAUSED = 9,
+    FORCE_PAUSED = 10,
+    STOP = 11,
+    STOPPED = 12,
+    DESTROYED = 13
 }
 declare class SlideApi {
     private readonly config;
@@ -1678,6 +1681,7 @@ declare class SlideApi {
     private readonly _getViewportWidth;
     private readonly _getViewportHeight;
     private readonly _overlappingActionBarHeight;
+    private readonly _separateUserAndAppPause;
     readonly sdkApi: SDKApi;
     constructor(config: {
         sdkApi: SDKApi;
@@ -1691,20 +1695,23 @@ declare class SlideApi {
         slideRatio: number;
         isFullscreen: boolean;
         slideLoadedCb?: (data: {
-            slide: Slide;
+            cardId: number;
+            slideIndex: number;
             result: boolean;
             reason?: string;
         }) => void;
         getViewportWidth: () => number;
         getViewportHeight: () => number;
         overlappingActionBarHeight?: number;
+        separateUserAndAppPause: boolean;
     });
     destroy(): void;
     private initListeners;
     private destroyListeners;
     private refreshSizes;
     showSlide(html: string): Promise<{
-        slide: Slide;
+        cardId: number;
+        slideIndex: number;
         result: boolean;
         reason?: string;
     }>;
@@ -1713,17 +1720,17 @@ declare class SlideApi {
     private getLocalData;
     private _fontsInit;
     private _initAndLoadFonts;
+    // todo nullable
     private _slide;
     private _slideInInit;
     private _state;
     private _afterStartInitQueue;
-    private _afterResumeQueue;
+    private _afterAppResumeQueue;
     get state(): STATE;
     private _onAllMediaLoaded;
     private _init;
     private _slideInRender;
     private _slideBoxRenderComplete;
-    private _slideBoxRenderError;
     private _slideConfig;
     slideStart(config: {
         muted?: boolean;
@@ -1736,8 +1743,16 @@ declare class SlideApi {
         currentTime: number;
     }>;
     private _pauseCbTimer;
-    slidePause(): Promise<void>;
-    slideResume(): Promise<void>;
+    slideUserPause(): Promise<void>;
+    slideUserResume(): Promise<void>;
+    /**
+     * Call on app gone background
+     */
+    slideAppPause(): Promise<void>;
+    /**
+     * Call on app gone foreground after a background
+     */
+    slideAppResume(): Promise<void>;
     slideStop(options: {
         prepareForRestart: ON_SLIDE_STOP_PREPARE_FOR_RESTART;
     }): Promise<void>;
@@ -1752,7 +1767,7 @@ declare class SlideApi {
     disableAudio(): void;
     get isStopped(): boolean;
     afterStartInitQueuePush(cb: () => void): false | undefined;
-    afterResumeQueuePush(cb: () => void): false | undefined;
+    afterAppResumeQueuePush(cb: () => void): false | undefined;
     get activeLayer(): Layer;
     get slide(): Slide;
     showLayer(index: number): void;

package/dist/index.d.ts

@@ -817,9 +817,9 @@ declare class SlideTimeline {
     private readonly slideDuration;
     private readonly slideDisabledTimer;
     private readonly slideReady;
-    private readonly _afterResumeQueuePush;
+    private readonly _afterAppResumeQueuePush;
     private readonly sdkApi;
-    constructor(slideIndex: number, slideDuration: number, slideDisabledTimer: boolean, slideReady: Promise<void>, _afterResumeQueuePush: (cb: () => void) => void, sdkApi: SDKApi);
+    constructor(slideIndex: number, slideDuration: number, slideDisabledTimer: boolean, slideReady: Promise<void>, _afterAppResumeQueuePush: (cb: () => void) => void, sdkApi: SDKApi);
     private resumedAt;
     private timeSpent;
     private timelineDisabledState;
@@ -1559,13 +1559,13 @@ declare class Video implements IElement {
 declare class Slide {
     private readonly _slidesNodesRefs;
     private readonly _slideReadyPromise;
-    private readonly _afterResumeQueuePush;
+    private readonly _afterAppResumeQueuePush;
     private readonly _afterStartInitQueuePush;
     private readonly _showNextSlide;
     readonly sdkApi: SDKApi;
     private readonly _layers;
     private _start;
-    constructor(_slidesNodesRefs: Array<HTMLElement>, _slideReadyPromise: Promise<void>, _afterResumeQueuePush: (cb: () => void) => void, _afterStartInitQueuePush: (cb: () => void) => void, _showNextSlide: (duration: number) => void, sdkApi: SDKApi);
+    constructor(_slidesNodesRefs: Array<HTMLElement>, _slideReadyPromise: Promise<void>, _afterAppResumeQueuePush: (cb: () => void) => void, _afterStartInitQueuePush: (cb: () => void) => void, _showNextSlide: (duration: number) => void, sdkApi: SDKApi);
     private _activeLayer;
     get activeLayer(): Layer;
     get layers(): Array<Layer>;
@@ -1591,7 +1591,7 @@ declare class Layer {
     private readonly _nodeRef;
     private readonly _slide;
     private readonly _slideReadyPromise;
-    private readonly _afterResumeQueuePush;
+    private readonly _afterAppResumeQueuePush;
     private readonly _afterStartInitQueuePush;
     private readonly _showNextSlide;
     readonly sdkApi: SDKApi;
@@ -1604,7 +1604,7 @@ declare class Layer {
     private readonly _disabledNavigation;
     private _elements;
     private readonly _timeline;
-    constructor(_nodeRef: HTMLElement, _slide: Slide, _slideReadyPromise: Promise<void>, _afterResumeQueuePush: (cb: () => void) => void, _afterStartInitQueuePush: (cb: () => void) => void, _showNextSlide: (duration: number) => void, sdkApi: SDKApi);
+    constructor(_nodeRef: HTMLElement, _slide: Slide, _slideReadyPromise: Promise<void>, _afterAppResumeQueuePush: (cb: () => void) => void, _afterStartInitQueuePush: (cb: () => void) => void, _showNextSlide: (duration: number) => void, sdkApi: SDKApi);
     init(localData: LocalData): Array<Promise<boolean>>;
     get nodeRef(): HTMLElement;
     get elements(): Array<IElement>;
@@ -1646,7 +1646,7 @@ declare class Layer {
     stopInternal(options: {
         prepareForRestart: ON_SLIDE_STOP_PREPARE_FOR_RESTART;
     }): void;
-    pause(resetVideoTime?: boolean, stopAnimation?: boolean): Promise<{
+    pause(resetVideoTime?: boolean, stopAnimation?: boolean, updateTimeline?: boolean): Promise<{
         currentTime: number | null;
     }>;
     resume(): Promise<unknown>;
@@ -1662,11 +1662,14 @@ declare const enum STATE {
     STARTED = 3,
     RESUME = 4,
     RESUMED = 5,
-    PAUSE = 6,
-    PAUSED = 7,
-    FORCE_PAUSED = 8,
-    STOP = 9,
-    STOPPED = 10
+    APP_PAUSE = 6,
+    APP_PAUSED = 7,
+    USER_PAUSE = 8,
+    USER_PAUSED = 9,
+    FORCE_PAUSED = 10,
+    STOP = 11,
+    STOPPED = 12,
+    DESTROYED = 13
 }
 declare class SlideApi {
     private readonly config;
@@ -1678,6 +1681,7 @@ declare class SlideApi {
     private readonly _getViewportWidth;
     private readonly _getViewportHeight;
     private readonly _overlappingActionBarHeight;
+    private readonly _separateUserAndAppPause;
     readonly sdkApi: SDKApi;
     constructor(config: {
         sdkApi: SDKApi;
@@ -1691,20 +1695,23 @@ declare class SlideApi {
         slideRatio: number;
         isFullscreen: boolean;
         slideLoadedCb?: (data: {
-            slide: Slide;
+            cardId: number;
+            slideIndex: number;
             result: boolean;
             reason?: string;
         }) => void;
         getViewportWidth: () => number;
         getViewportHeight: () => number;
         overlappingActionBarHeight?: number;
+        separateUserAndAppPause: boolean;
     });
     destroy(): void;
     private initListeners;
     private destroyListeners;
     private refreshSizes;
     showSlide(html: string): Promise<{
-        slide: Slide;
+        cardId: number;
+        slideIndex: number;
         result: boolean;
         reason?: string;
     }>;
@@ -1713,17 +1720,17 @@ declare class SlideApi {
     private getLocalData;
     private _fontsInit;
     private _initAndLoadFonts;
+    // todo nullable
     private _slide;
     private _slideInInit;
     private _state;
     private _afterStartInitQueue;
-    private _afterResumeQueue;
+    private _afterAppResumeQueue;
     get state(): STATE;
     private _onAllMediaLoaded;
     private _init;
     private _slideInRender;
     private _slideBoxRenderComplete;
-    private _slideBoxRenderError;
     private _slideConfig;
     slideStart(config: {
         muted?: boolean;
@@ -1736,8 +1743,16 @@ declare class SlideApi {
         currentTime: number;
     }>;
     private _pauseCbTimer;
-    slidePause(): Promise<void>;
-    slideResume(): Promise<void>;
+    slideUserPause(): Promise<void>;
+    slideUserResume(): Promise<void>;
+    /**
+     * Call on app gone background
+     */
+    slideAppPause(): Promise<void>;
+    /**
+     * Call on app gone foreground after a background
+     */
+    slideAppResume(): Promise<void>;
     slideStop(options: {
         prepareForRestart: ON_SLIDE_STOP_PREPARE_FOR_RESTART;
     }): Promise<void>;
@@ -1752,7 +1767,7 @@ declare class SlideApi {
     disableAudio(): void;
     get isStopped(): boolean;
     afterStartInitQueuePush(cb: () => void): false | undefined;
-    afterResumeQueuePush(cb: () => void): false | undefined;
+    afterAppResumeQueuePush(cb: () => void): false | undefined;
     get activeLayer(): Layer;
     get slide(): Slide;
     showLayer(index: number): void;