@wscsports/blaze-web-sdk 0.1.991 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wscsports/blaze-web-sdk",
-  "version": "0.1.991",
+  "version": "0.2.00",
   "main": "publish/index",
   "types": "publish/index",
   "files": [

package/publish/index.d.ts

@@ -427,12 +427,13 @@ export * from './database';
 interface IAdInfoConfiguration {
     adLocationsIndexes: Array<number>;
     isActive: boolean;
+    adsLocationType: 'FixedPages' | 'EveryXStories';
 }
 export interface IAdInfo {
     path?: string;
     tag?: string;
     type: 'Web' | 'IMA';
-    configuration: IAdInfoConfiguration;
+    configuration?: IAdInfoConfiguration;
 }
 
 export interface IContent {
@@ -452,6 +453,7 @@ export interface ICTA {
     textColor: string;
 }
 
+export * from './ad-info.interface';
 export * from './content.interface';
 export * from './cta.interface';
 export * from './interaction.interface';
@@ -578,7 +580,8 @@ export declare enum InternalEvent {
     NEXT_STORY = "next_story",
     PREV_STORY = "prev_story",
     FULL_SCREEN_CLICK = "full_screen_click",
-    AD_ENDED = "ad_ended"
+    AD_ENDED = "ad_ended",
+    AD_RESUMED = "ad_resumed"
 }
 
 export * from './error-codes.enum';
@@ -811,6 +814,7 @@ export * from './database.interface';
 export * from './device.interface';
 export * from './drawable.interface';
 export * from './icons.interface';
+export * from './player.interface';
 export * from './response.interface';
 export * from './service.interface';
 export * from './widget-label-builder.interface';
@@ -822,6 +826,8 @@ export default interface IntersectionObservable {
     handleIntersection(entries: IntersectionObserverEntry[]): void;
 }
 
+export type ScreenMode = 'Full Screen' | 'Embedded';
+
 export interface IResponse<T = any> {
     data: T;
     error?: Error;
@@ -885,6 +891,7 @@ declare const AdServiceClass_base: {
 declare abstract class AdServiceClass extends AdServiceClass_base implements IService {
     canRunAds: boolean;
     init(): Promise<void>;
+    pushCustomNativeAdsBetweenStories(defaultAdsInfo: IAdInfo | undefined, widgets: BlazeWidgetStory[], stories: IStory[], index: number, playerLayout: StoryPlayerStyle, showInteraction: boolean, mode?: ScreenMode): void;
 }
 export declare const AdService: AdServiceClass;
 
@@ -1094,6 +1101,7 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
             assetsExpiryTime: string;
             totalItems: number;
             result: IStory[];
+            defaultAdsInfo?: IAdInfo | undefined;
         };
         error?: Error | undefined;
     }>;
@@ -1103,6 +1111,7 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
             assetsExpiryTime: string;
             totalItems: number;
             result: IStory[];
+            defaultAdsInfo?: IAdInfo | undefined;
         };
         error?: Error | undefined;
     }>;
@@ -1247,7 +1256,7 @@ declare abstract class EventServiceClass extends EventServiceClass_base implemen
     private rootElement;
     constructor();
     init(): Promise<void>;
-    dispatch(el: HTMLElement, event: Delegation, params?: object): {
+    dispatch(el: HTMLElement | undefined, event: Delegation, params?: object): {
         mainEvent: CustomEvent;
     };
     dispatchAnaltyicsEvent(name: string, event: any): {
@@ -1364,6 +1373,7 @@ declare abstract class VideoPlayerServiceClass extends VideoPlayerServiceClass_b
     private _isNavigating;
     private _isModalOpen;
     private _playReference;
+    muteStateBeforeAd: 'mute' | 'unmute' | 'no-ad';
     constructor();
     init(): Promise<void>;
     get isMuted(): boolean;
@@ -2089,11 +2099,14 @@ export * from './widget-story-video';
 export declare class BlazeWidgetStoryAd extends BlazeWidgetStoryBase {
     private storyParent;
     data: IPage | undefined;
-    private isCurrectlyDisplay;
+    private isCurrentlyDisplay;
     private adContainer;
     private placeholderContainer;
     private googletag;
     private failToLoadTimeout?;
+    private onFail?;
+    private isAdFailed;
+    private isPlaying;
     constructor(storyParent: BlazeWidgetStory);
     connectedCallback(): void;
     disconnectedCallback(): void;
@@ -2106,15 +2119,19 @@ export declare class BlazeWidgetStoryAd extends BlazeWidgetStoryBase {
     getAdIframeRef(): HTMLIFrameElement | null;
     changeAdMutedState(isMuted: boolean): void;
     setData(data: IPage): void;
+    startEnter(): Promise<void>;
+    endExit(): void;
     play(): void;
     get paused(): boolean;
     pause(): void;
     removeLoader(): void;
     loadPoster(): void;
     hide(): void;
-    display(onFail?: () => void): void;
+    display(onFail?: () => void): Promise<void>;
     mainElement(): CanvasImageSource;
     private initStyles;
+    isAdContainerConncetedToDOM(): Promise<boolean>;
+    private destroyAd;
 }
 
 export declare class BlazeWidgetCtaModal extends BaseWidget {
@@ -2150,6 +2167,8 @@ export declare class BlazeWidgetEmbeddedStory extends BaseWidget implements IWid
     modal?: BlazeWidgetStoryModal;
     skeleton?: BlazeWidgetItemSkeleton;
     shouldReloadData: boolean;
+    defaultAdsInfo?: IAdInfo;
+    isCurrentPlayerFirstPlay: boolean;
     bindedOnStoryPlayerDidAppear: (e: Event) => void;
     bindedOnStoryPlayerDismissed: (e: Event) => void;
     private get theme();
@@ -2174,7 +2193,7 @@ export declare class BlazeWidgetEmbeddedStory extends BaseWidget implements IWid
     setMaxItemsSize(size: number): void;
     get currentStoryPlayer(): BlazeWidgetStory | undefined;
     private loadStories;
-    setCurrentStoryPlayer(storyIndex: number, pageIndex?: number): void;
+    setCurrentStoryPlayer(playerIndex: number, pageIndex?: number): void;
     handleIntersection(entries: IntersectionObserverEntry[]): void;
     nextStory(): void;
     prevStory(): void;
@@ -2187,6 +2206,7 @@ export declare class BlazeWidgetEmbeddedStory extends BaseWidget implements IWid
     pauseCurrentStoryPage(): void;
     playCurrentStoryPage(): void;
     onCustomNativeAdEnded(): void;
+    onVastAdResumedEnded(): void;
     showSkeleton(): void;
     hideSkeleton(): void;
     private onStoryPlayerDidAppear;
@@ -2276,6 +2296,7 @@ export declare class BlazeWidgetLabel {
 export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements Observable, IWidgetView {
     modal: BlazeWidgetStoryModal | undefined;
     modalMoments: BlazeWidgetMomentModal | undefined;
+    defaultAdsInfo: IAdInfo | undefined;
     stories: IStory[];
     moments: IMoment[];
     skeletonContainer: BlazeDiv | undefined;
@@ -2618,6 +2639,7 @@ export declare class BlazeWidgetStoryBase extends HTMLElement {
     shouldShowImaAd?: boolean;
     isCurrentlyTryingToRunImaAd?: boolean;
     _isAd?: boolean | undefined;
+    adsManager?: any;
     constructor();
     setData(data: IPage): void;
     loadPoster(): void;
@@ -2643,6 +2665,10 @@ export declare class BlazeWidgetStoryBase extends HTMLElement {
     connectedCallback(): void;
     disconnectedCallback(): void;
     render(): void;
+    startEnter(): void;
+    startExit(): void;
+    endEnter(): void;
+    endExit(): void;
 }
 
 export declare class BlazeWidgetStoryImage extends BlazeWidgetStoryBase {
@@ -2686,7 +2712,7 @@ export declare class BlazeWidgetStoryModal extends BlazeWidgetModal {
     constructor(parentWidget: HTMLElement, playerLayout: StoryPlayerStyle);
     handleOnStoryChange(mode: StoryDirectionType): void;
     setTheme(theme: IWidgetTheme): void;
-    setStories(stories: IStory[], showInteraction?: boolean): void;
+    setStories(stories: IStory[], showInteraction?: boolean, defaultAdsInfo?: IAdInfo): void;
     seek(id: string): void;
     handleExit(): void;
     onKeyDown(ev: KeyboardEvent): void;
@@ -2735,6 +2761,7 @@ export declare class BlazeWidgetStoryPlayer extends BaseWidget {
     attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
     private setupHammer;
     private isTouchOnScreenEdges;
+    private isCurrentlyDisplayingVastAd;
     private handlePanStart;
     private handlePanMove;
     private handlePanEnd;
@@ -2891,7 +2918,7 @@ export declare class BlazeWidgetStoryVideo extends BlazeWidgetStoryBase {
 
 export declare class BlazeWidgetStory extends HTMLElement {
     playerStyle: StoryPlayerStyle;
-    mode: 'Full Screen' | 'Embedded';
+    mode: ScreenMode;
     pages: BlazeWidgetStoryBase[];
     data: IStory;
     shareModal?: BlazeWidgetShareModal;
@@ -2946,11 +2973,10 @@ export declare class BlazeWidgetStory extends HTMLElement {
     lastPageIndexToResume: number;
     elementsToHideOnWebAds: (HTMLElement | undefined)[];
     elementsToHideOnImaAds: (HTMLElement | undefined)[];
-    muteStateBeforeAd: 'mute' | 'unmute' | 'no-ad';
     longPressHandler?: LongPressHandler;
     originalNextPageDesktopClickListener: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null | undefined;
     restartStoryOnClickEvent: ((event: MouseEvent) => void) | undefined;
-    constructor(playerStyle: StoryPlayerStyle, mode: 'Full Screen' | 'Embedded');
+    constructor(playerStyle: StoryPlayerStyle, mode: ScreenMode);
     private isButtonVisible;
     private createPlayerButtonsAndAppendToButtonsContainer;
     private createNavigationButtonsAndAppendToWidgetStoryContainer;
@@ -2964,7 +2990,9 @@ export declare class BlazeWidgetStory extends HTMLElement {
     setPlayerButtonPosition(state: 'AD' | 'NO_AD'): void;
     updatePlayerButtonIcons(): void;
     handleCtaAction(event: Event, gestureType: 'Swipe Up' | 'CTA Click'): boolean;
-    playToggle(): void;
+    playToggle(options?: {
+        customIsPlaying?: boolean;
+    }): void;
     muteToggle(): boolean;
     setWidgetParent(parent: BlazeWidgetItem): void;
     resetStoryLocationIndexToLastUnseen(): void;
@@ -2990,7 +3018,6 @@ export declare class BlazeWidgetStory extends HTMLElement {
     updateContainerLayout(): void;
     connectedCallback(): void;
     onShareModalClose(): void;
-    onCtaModalClick(): void;
     onShareModalButtonClick(shareButton: BlazeShareButton): Promise<void>;
     onVisibilityChange(): void;
     onBlur(): void;