@inappstory/react-sdk 1.8.0-rc.1 → 1.8.0-rc.3

package/plugins/banners/types/bannerPlace.d.ts

@@ -6,16 +6,24 @@ import { BannerPlaceAppearance } from "./bannerPlaceAppearance";
  * @enum {string}
  */
 export enum BannerPlaceViewModelEvent {
-    /** Emitted when playback starts */
-    Play = "play",
-    /** Emitted when playback stops */
-    Stop = "stop",
     /** Emitted when banner loading starts */
     LoadStart = "loadStart",
     /** Emitted when banner loading completes */
     LoadEnd = "loadEnd",
     /** Emitted when banner loading fails */
-    LoadError = "loadError"
+    LoadError = "loadError",
+    /** Emitted when changed active banner */
+    ActiveIndexChange = "activeIndexChange",
+    /** Emitted before transition to the next slide after the duration has elapsed */
+    AutoplayTimeLeft = "autoplayTimeLeft",
+    /** Emitted while autoplay timer tick */
+    AutoplayTimerTick = "autoplayTimerTick",
+    /** Emitted when the banner is in the viewport and started. */
+    ShowBanner = "showBanner",
+    /** Emitted when the banner is in the viewport and error occurs on start. */
+    ShowBannerFailed = "showBannerFailed",
+    /** Emitted when interacting with banner widgets */
+    BannerWidget = "bannerWidget"
 }
 
 /**
@@ -135,6 +143,12 @@ export interface BannerPlace {
      */
     get activeIndex(): number;
 
+    /**
+     * Gets pagination bullets length
+     * @returns {number}
+     */
+    get paginationBullets(): number;
+
     /**
      * Sets the slider controller implementation
      * @param {IBannerPlaceSliderController} sliderController - The slider controller to use
@@ -148,14 +162,31 @@ export interface BannerPlace {
     updateAppearance(appearance: BannerPlaceAppearance): void;
 
     /**
-     * Starts playback of all banners
+     * Resume autoplay
      */
-    play(): void;
+    resume(): void;
 
     /**
-     * Stops playback of all banners
+     * Pause autoplay
      */
-    stop(): void;
+    pause(): void;
+
+    /**
+     * Run transition to next slide.
+     */
+    showNext(): void;
+
+    /**
+     * Run transition to previous slide.
+     */
+    showPrevious(): void;
+
+    /**
+     * Run transition to the slide by index
+     * @param {number} index - Slide index
+     * @param {number} speed - Transition duration
+     */
+    showByIndex(index: number, speed?: number): void;
 
     /**
      * Reloads banners for this place
@@ -181,6 +212,12 @@ export interface BannerPlace {
      * @emits BannerPlaceViewModelEvent.LoadStart
      * @emits BannerPlaceViewModelEvent.LoadEnd
      * @emits BannerPlaceViewModelEvent.LoadError
+     * @emits BannerPlaceViewModelEvent.ActiveIndexChange
+     * @emits BannerPlaceViewModelEvent.AutoplayTimeLeft
+     * @emits BannerPlaceViewModelEvent.AutoplayTimerTick
+     * @emits BannerPlaceViewModelEvent.ShowBanner
+     * @emits BannerPlaceViewModelEvent.ShowBannerFailed
+     * @emits BannerPlaceViewModelEvent.BannerWidget,
      */
     fetchBanners(): Promise<Banner[]>;
 }

package/plugins/banners/types/events.d.ts

@@ -0,0 +1,27 @@
+export interface ShowBannerEvent {
+    id: string;
+    bannerPlace: string;
+    payload?: string;
+}
+
+export interface ShowBannerFailedEvent {
+    id: string;
+    bannerPlace: string;
+    error: Error;
+    payload?: string;
+}
+
+export interface BannerWidgetEvent {
+    id: string;
+    bannerPlace: string;
+    widgetEventName: string;
+    widgetData: Record<string, any>;
+    payload?: string;
+}
+
+export interface AutoplayTimerTickEvent {
+    bannerIndex: number;
+    currentTime: number;
+    totalTime: number;
+    percents: number;
+}

package/plugins/banners/types/iasBannerPlace.d.ts

@@ -1,5 +1,6 @@
 import { BannerPlace } from "./bannerPlace";
 import { BannerPlaceAppearance } from "./bannerPlaceAppearance";
+import { AutoplayTimerTickEvent, BannerWidgetEvent, ShowBannerEvent, ShowBannerFailedEvent } from "./events";
 
 /**
  * Props for IasBannerPlace component
@@ -52,12 +53,48 @@ interface IasBannerPlaceProps {
      */
     onLoadError?: (error: Error) => void;
 
+    /**
+     * Callback triggered when changed active banner
+     * @optional
+     */
+    onActiveIndexChange?: (index: number) => void;
+
+    /**
+     * Callback triggered before transition to the next slide after the duration has elapsed
+     * @optional
+     */
+    onAutoplayTimeLeft?: () => void;
+
+    /**
+     * Callback triggered when autoplay timer tick
+     * @optional
+     */
+    onAutoplayTimerTick?: (event: AutoplayTimerTickEvent) => void;
+
     /**
      * Callback triggered when banner place is ready
      * @param {BannerPlace} bannerPlace - The initialized banner place instance
      * @optional
      */
     onReady?: (bannerPlace: BannerPlace) => void;
+
+    /**
+     * Triggered when the banner is in the viewport and started.
+     * @optional
+     */
+    onShowBanner?: (event: ShowBannerEvent) => void;
+
+    /**
+     * Triggered when the banner is in the viewport and error occurs on start.
+     * @optional
+     */
+    onShowBannerFailed?: (event: ShowBannerFailedEvent) => void;
+
+    /**
+     * Triggered when interacting with banner widgets.
+     * @optional
+     */
+    onBannerWidget?: (event: BannerWidgetEvent) => void;
 }
 
 /**

package/plugins/banners/types/index.d.ts

@@ -4,6 +4,7 @@ export * from "./bannerPlaceAppearance";
 export * from "./iasBannerPlace";
 export * from "./iasBannerPreview";
 export * from "./iasBannersProvider";
+export * from "./events"
 
 import { IasBannersProvider } from "./iasBannersProvider";