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

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

@@ -16,6 +16,8 @@ export enum BannerPlaceViewModelEvent {
     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. */
@@ -212,9 +214,10 @@ export interface BannerPlace {
      * @emits BannerPlaceViewModelEvent.LoadError
      * @emits BannerPlaceViewModelEvent.ActiveIndexChange
      * @emits BannerPlaceViewModelEvent.AutoplayTimeLeft
+     * @emits BannerPlaceViewModelEvent.AutoplayTimerTick
      * @emits BannerPlaceViewModelEvent.ShowBanner
      * @emits BannerPlaceViewModelEvent.ShowBannerFailed
-     * @emits BannerPlaceViewModelEvent.BannerWidget
+     * @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
@@ -53,10 +54,10 @@ interface IasBannerPlaceProps {
     onLoadError?: (error: Error) => void;
 
     /**
-     * Callback triggered when when changed active banner
+     * Callback triggered when changed active banner
      * @optional
      */
-    onActiveIndexChange?: () => void;
+    onActiveIndexChange?: (index: number) => void;
 
     /**
      * Callback triggered before transition to the next slide after the duration has elapsed
@@ -64,12 +65,36 @@ interface IasBannerPlaceProps {
      */
     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";