@wscsports/blaze-web-sdk 0.13.3 → 0.13.5

package/package.json

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

package/publish/index.d.ts

@@ -328,6 +328,7 @@ export declare class ImaAdEvent {
     'audio_state': string;
     'content_type': string;
     'backoffice_campaign_data': string;
+    'session_id': string;
 }
 export declare class InteractionEvent {
     'interaction_id': string;
@@ -662,6 +663,10 @@ export declare const PLAYER_MENU_EVENTS: {
     readonly EXPAND: "player-menu-expand";
     readonly COLLAPSE: "player-menu-collapse";
 };
+export declare const PLAYER_MENU_ATTRIBUTES: {
+    readonly OPEN: "open";
+    readonly EXPANDED: "expanded";
+};
 export declare class BlazePlayerMenu extends BaseWidget {
     private menuOptions;
     private menuComponent;
@@ -671,6 +676,7 @@ export declare class BlazePlayerMenu extends BaseWidget {
     private titleElement;
     private closeButton;
     menuContainer: BlazeDiv;
+    private boundPreventScrollBubbling;
     private detachTouchEventListeners;
     constructor();
     connectedCallback(): void;
@@ -678,6 +684,7 @@ export declare class BlazePlayerMenu extends BaseWidget {
     setAttribute(qualifiedName: string, value: string): void;
     private setupEventListeners;
     private detachEventListeners;
+    private preventScrollBubbling;
     init(options: IPlayerMenuOptions): void;
     private buildHeader;
     private buildBackdrop;
@@ -978,9 +985,32 @@ export * from './css.constants';
 export * from './cc-supported-languages.constants';
 export * from './closed-captions.constants';
 export * from './common.constants';
+export * from './network.constants';
 
 export declare const CountryCodes: readonly ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"];
 
+export interface NetworkConfig {
+    posterLimits: {
+        previous: number;
+        next: number;
+    };
+    videoPreloadLimits: {
+        next: number;
+    };
+}
+export type NetworkSpeed = 'slow' | 'medium' | 'fast';
+export declare const NETWORK_CONFIGS: Record<NetworkSpeed, NetworkConfig>;
+export declare const DEFAULT_NETWORK_SPEED: NetworkSpeed;
+export declare function getNavigatorConnection(): any;
+export declare function getNetworkSpeed(downlinkMbps: number): NetworkSpeed;
+export declare function getPosterLimits(): {
+    previous: number;
+    next: number;
+};
+export declare function getVideoPreloadLimits(): {
+    next: number;
+};
+
 export declare const DEFAULT_CTA_HEIGHT = 40;
 export declare const MIN_PADDING_BOTTOM = 10;
 export declare const Z_INDEX: {
@@ -1032,6 +1062,7 @@ interface IBaseAdInfo {
     configuration?: IAdInfoConfiguration;
     context?: IAdContext;
     externalAdServerId?: string;
+    backofficeCampaignData?: string;
 }
 export interface IImaAdInfo extends IBaseAdInfo {
     type: 'IMA';
@@ -1042,7 +1073,7 @@ export interface IWebAdInfo extends IBaseAdInfo {
     type: 'Web';
     path: string;
 }
-export interface IBannerAdInfo {
+export interface IBannerAdInfo extends IBaseAdInfo {
     type: 'Banner';
     adUnitId: string;
     size: 'Banner';
@@ -1221,7 +1252,7 @@ export interface IMoment extends IContent {
         type: string;
     };
     cta: ICta;
-    adPath?: string;
+    adInfo?: IAdInfo;
     subtitle?: string;
     description?: string;
 }
@@ -3245,6 +3276,7 @@ export * from './environment.type';
 export * from './gesture.type';
 export * from './item.type';
 export * from './label.type';
+export * from './loading.type';
 export * from './locale.type';
 export * from './order.type';
 export * from './personalized.type';
@@ -3280,9 +3312,11 @@ export type PerItemStyleOverrides = Partial<Record<EntitiesType, Array<{
 
 export type LabelsType = string | string[] | BlazeWidgetLabel;
 
+export type LoadingType = 'cache' | 'direct';
+
 export type LocaleDirectionType = 'LTR' | 'RTL';
 
-export type OrderType = 'Manual' | 'AtoZ' | 'ZtoA' | 'RecentlyUpdatedFirst' | 'RecentlyUpdatedLast' | 'RecentlyCreatedFirst' | 'RecentlyCreatedLast';
+export type OrderType = 'Manual' | 'AtoZ' | 'ZtoA' | 'RecentlyUpdatedFirst' | 'RecentlyUpdatedLast' | 'RecentlyCreatedFirst' | 'RecentlyCreatedLast' | 'Random';
 export type ContentOrderType = 'LIVE_CHIP' | 'STORY_TITLE' | 'PUBLISHED_DATE';
 
 type BlazePersonalizedIds = {
@@ -3421,18 +3455,18 @@ export declare function findParentOfType<T>(target: EventTarget | null, type: {
     new (...args: any[]): T;
 }, stopAt: Element): T | null;
 
+export * from './ad-info.utils';
+export * from './cc-language.utils';
 export * from './chip.utils';
 export * from './common.utils';
 export * from './country-location.utils';
 export * from './guard.utils';
 export * from './helper';
 export * from './personalized.utils';
-export * from './regex.utils';
-export * from './stopwatch';
 export * from './position.utils';
-export * from './ad-info.utils';
-export * from './cc-language.utils';
+export * from './regex.utils';
 export * from './shared-event-target.utils';
+export * from './stopwatch';
 
 export declare function getPersonalizedParamsForRequest(personalized?: BlazePersonalized): {
     PersonalPlayers?: undefined;
@@ -3478,6 +3512,8 @@ export declare class Stopwatch {
     reset(): void;
 }
 
+export declare function getVideoDuration(existingVideo?: HTMLVideoElement, videoUrl?: string): Promise<number>;
+
 export * from './commands/player-buttons.command';
 export * from './commands/video-commands';
 export * from './components/timer';
@@ -3825,7 +3861,7 @@ export declare class BlazeVideoNavigationOverlay extends HTMLElement {
     loader: BlazeLoader;
     private _platform;
     constructor();
-    static get observedAttributes(): ("hidden" | "layout" | "has-next" | "has-prev")[];
+    static get observedAttributes(): ("layout" | "hidden" | "has-next" | "has-prev")[];
     attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
     private applyAttribute;
     connectedCallback(): void;
@@ -3933,8 +3969,9 @@ export declare class BlazeVideoElement extends BlazeWidgetVideoBase {
     videoOverlay: BlazeLongFormControlsOverlay;
     shareModal: BlazeWidgetShareModal;
     closedCaptionsModal: BlazeWidgetClosedCaptionsModal | undefined;
-    private widgetVastAd;
+    widgetVastAd: BlazeWidgetVastAd;
     private adPercentageShownPlaces;
+    private adIndex;
     private lastSavedTime;
     private lastSeekAction;
     private shouldSaveAfterSeek;
@@ -4223,8 +4260,8 @@ export declare class BlazeWidgetClosedCaptionsModal extends BaseWidget {
     private onMenuCollapse;
     open(): void;
     close(): void;
-    get isOpen(): boolean;
-    reloadData(data: IClosedCaption[]): void;
+    isOpen(): boolean;
+    reloadData(data: IClosedCaption[] | undefined): void;
     private handleCcOptionClick;
     private buildCcOption;
     private fillContainerWithOptions;
@@ -4253,10 +4290,15 @@ export declare abstract class BlazeWidgetContent extends HTMLElement {
     widgetParentItem: BlazeWidgetItem;
     sessionId: string;
     refContentModal?: BlazeWidgetStoryModal | BlazeWidgetMomentModal | BlazeWidgetVideoModal;
+    adIndex: number;
     abstract aspectRatio?: ContentAspectRatio;
+    private detachTimeout;
+    private isScheduledForDetach;
     constructor();
     connectedCallback(): void;
     disconnectedCallback(): void;
+    attachEventListeners(): void;
+    detachEventListeners(): void;
     setWidgetItemParent(item: BlazeWidgetItem): void;
     updateWidgetStatusReadUnread(): void;
     getRefferingObject(): ReferringEventInfo;
@@ -4759,7 +4801,7 @@ export declare class BlazeWidgetVideoBase extends HTMLElement {
     shouldShowImaAd?: boolean;
     isCurrentlyTryingToRunImaAd?: boolean;
     _isAd?: boolean | undefined;
-    adsManager?: any;
+    widgetVastAd?: BlazeWidgetVastAd;
     constructor();
     setData(data: IPage | IVideo): void;
     loadPoster(): void;
@@ -4773,7 +4815,7 @@ export declare class BlazeWidgetVideoBase extends HTMLElement {
     get isAd(): boolean | undefined;
     set isAd(value: boolean | undefined);
     removeLoader(): any;
-    load(): void;
+    load(loadingType?: LoadingType): void;
     unload(): void;
     display(onFail?: () => void): void;
     hide(): void;
@@ -4809,19 +4851,19 @@ export declare class BlazeWidgetVideo extends BlazeWidgetVideoBase {
     isLoaded: boolean;
     isVideoRunning: boolean;
     maxRetryTimes: number;
-    adContainer: HTMLElement;
-    adLoaderContainer: BlazeLoader;
-    adDisplayContainer: any;
-    adsManager: any;
     shouldShowImaAd: boolean;
     isCurrentlyTryingToRunImaAd: boolean;
     hasPoster: boolean;
+    widgetVastAd: BlazeWidgetVastAd;
+    private boundHandleAdStarted;
+    private boundHandleAdEnded;
     boundLanguageChangeEvent: (event: Event) => void;
     static get observedAttributes(): string[];
     constructor(contentParent: BlazeWidgetStory | BlazeWidgetMoment);
     attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
     connectedCallback(): void;
     disconnectedCallback(): void;
+    private getContentType;
     setData(data: IPage): void;
     getGoogleIMA(): any;
     private isEnableInteractions;
@@ -4830,7 +4872,8 @@ export declare class BlazeWidgetVideo extends BlazeWidgetVideoBase {
     loadPoster(): void;
     display(): void;
     hide(): void;
-    load(loadingType?: 'cache' | 'direct'): Promise<void>;
+    load(loadingType?: LoadingType): Promise<void>;
+    setVideoSource(videoUrl: string): void;
     unload(): Promise<void>;
     resetVideoState(): void;
     removeLoader(): void;
@@ -4851,26 +4894,12 @@ export declare class BlazeWidgetVideo extends BlazeWidgetVideoBase {
     get isAd(): boolean;
     render(): void;
     restartVideo(): void;
-    initializeIMA(): Promise<void>;
-    buildImaUrl(iamData: IImaAdInfo, pageIndex?: number, contentExtraInfo?: ContentExtraInfo): Promise<string>;
-    buildAndSetCustParams(iamData: IImaAdInfo, newUrl: URL, pageIndex?: number): void;
-    setSearchParamIfNotNullOrZero(newUrl: URL, key: string, value?: string | number): void;
-    addAniviewMacrosToUrl(newUrl: URL): void;
-    addGoogleAdsMacrosToUrl(newUrl: URL): void;
-    onAdsManagerLoaded(adsManagerLoadedEvent: any): void;
-    onAdEvent(adEvent: any): void;
-    onWindowResize(): void;
-    onVisibile(): void;
-    onBlur(): void;
-    onFocus(): void;
-    onAdError(): void;
-    loadAds(): void;
-    onContentPauseRequested(): void;
-    onContentResumeRequested(): void;
-    removeAdLoader(): void;
+    handleAdStarted(): void;
+    handleAdEnded(): void;
     loadInteraction(): void;
     onLanguageChange(event: Event): Promise<void>;
     handleInteractionEvent(event: CustomEvent<InteractionAnalyticCustomEvent>): void;
+    private tryToPlayAd;
 }
 
 export declare class BlazeWidgetAd extends BlazeWidgetVideoBase {
@@ -4901,6 +4930,7 @@ export declare class BlazeWidgetAd extends BlazeWidgetVideoBase {
     setData(data: IPage): void;
     startEnter(): Promise<void>;
     endExit(): void;
+    getIframeVideoElement(): HTMLVideoElement | undefined;
     play(): void;
     get paused(): boolean;
     pause(): void;
@@ -4932,9 +4962,11 @@ export declare class BlazeWidgetBannerAd extends HTMLElement {
     raiseAnalyticsViewBannerAd(): void;
 }
 
+type AddExtraAnalyticsParams = () => Partial<ImaAdEvent>;
 export declare class BlazeWidgetVastAd extends HTMLElement {
     private contentType;
     private getReferringObject?;
+    private isInitialized;
     private adDisplayContainer?;
     private adsManager?;
     private adsLoader?;
@@ -4943,16 +4975,16 @@ export declare class BlazeWidgetVastAd extends HTMLElement {
     private videoElement?;
     private currentAdTag;
     private currentAdInfo?;
+    private currentAddExtraAnalyticsParams?;
     private boundedOnBlur;
     private boundedOnFocus;
     private boundedOnVisibilityChange;
     private boundedOnWindowResize;
-    adIndex: number;
     get googleIMA(): any;
     constructor(contentType: ContentType, getReferringObject?: (() => ReferringEventInfo) | undefined);
     private initializeGoogleIma;
     private buildImaUrl;
-    startAd(videoElement: HTMLVideoElement, adInfo: IImaAdInfo, contentExtraInfo: ContentExtraInfo): Boolean;
+    startAd(videoElement: HTMLVideoElement, adInfo: IImaAdInfo, contentExtraInfo?: ContentExtraInfo, addCustomParams?: (url: URL) => void, addExtraAnalyticsParams?: AddExtraAnalyticsParams): Promise<Boolean>;
     private onAdsManagerLoaded;
     private loadAds;
     private onAdEvent;
@@ -4964,6 +4996,12 @@ export declare class BlazeWidgetVastAd extends HTMLElement {
     private onFocus;
     private onVisibilityChange;
     private onWindowResize;
+    setSearchParamIfNotNullOrZero(newUrl: URL, key: string, value?: string | number): void;
+    private addAniviewMacrosToUrl;
+    private addGoogleAdsMacrosToUrl;
+    private buildAndSetCustParams;
+    pause(): void;
+    resume(): void;
 }
 
 export type BlazeWidgetContentType = BlazeWidgetMoment[] & BlazeWidgetStory[] & BlazeVideoElement[];
@@ -5003,6 +5041,8 @@ export declare const UPDATE_NAVIGATION_BUTTONS_EVENT = "updateNavigationButtons"
 export declare class BlazeWidgetMomentPlayer extends WidgetAbstractPlayer {
     isWheelEventHandling: boolean;
     boundHandleMuteClicked: () => void;
+    private fetchedPosterUrls;
+    private preloadTimer;
     constructor();
     get currentMoment(): BlazeWidgetMoment;
     connectedCallback(): void;
@@ -5025,8 +5065,11 @@ export declare class BlazeWidgetMomentPlayer extends WidgetAbstractPlayer {
     handleAnimationCompletion(content: BlazeWidgetMoment, mode: ContentDirection): Promise<void>;
     loadAndPlayContent(): Promise<void>;
     setContent(content: BlazeWidgetMoment[]): void;
-    preloadAdjacentContent(direction: ContentDirection): Promise<void>;
-    prefetchPosters(): Promise<void>;
+    preloadAdjacentVideos(): void;
+    preloadAdjacentPosters(): void;
+    private getCurrentContentIndex;
+    private getIndicesRange;
+    private fetchPosterAtIndex;
     play(): void;
     pause(): void;
     onAnimationEnd(): void;
@@ -5096,6 +5139,7 @@ export declare class BlazeWidgetMomentSeekBar extends HTMLElement {
 interface ButtonElementOptions {
     iconUrl: string;
     width: string;
+    testId: string;
     height: string;
     onClick?: (this: GlobalEventHandlers, ev: MouseEvent) => void;
     backgroundColor?: string;
@@ -5207,8 +5251,7 @@ export declare class BlazeWidgetMoment extends BlazeWidgetContent {
     private handleOnClosedCaptionClick;
     toggleClosedCaptions(language?: CcLanguageCode): void;
     handleOnShareClick(): Promise<void>;
-    loadMoments(): Promise<void>;
-    load(loadingType?: 'direct' | 'cache'): Promise<void>;
+    load(loadingType?: LoadingType): Promise<void>;
     unload(): Promise<void>;
     playToggle(): void;
     handleOnMuteUnmuteToggle(): void;
@@ -5409,7 +5452,7 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     unload(): void;
     removeFromCache(): void;
     displayCurrentStoryPageAndHideTheRest(): void;
-    load(): void;
+    load(loadingType?: LoadingType): void;
     play(): void;
     bannerAdEvent(detail: InternalEventDetails[InternalEvent.BANNER_ANALYTICS]): void;
     event(action: StoryAction, storyData: Partial<StoryEvent>, label?: string | undefined): Promise<void>;