@wscsports/blaze-web-sdk 0.11.1 → 0.13.0

package/package.json

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

package/publish/index.d.ts

@@ -209,6 +209,7 @@ export declare class StoryEvent {
     'player_orientation': ContentAspectRatio;
     'cc_state': string;
     'content_extra_info': string;
+    'story_page_content_extra_info': string;
     'custom_action_button_name': string;
     'enrichment_layer_id': string;
     'enrichment_layer_url': string;
@@ -287,6 +288,8 @@ export declare class AdEvent {
     'ad_server': string;
     'story_id': string;
     'story_title': string;
+    'story_page_id': string;
+    'story_page_index': number;
     'ad_insertion_logic': string;
     'ad_index': string;
     'ad_start_trigger': string;
@@ -467,7 +470,15 @@ export * from './data-source.class';
 export * from './fullscreen-manager.class';
 export * from './visiblity-manager.class';
 
-export declare class BlazeWidgetLabel {
+export interface IBlazeWidgetLabel {
+    readonly _type: 'BlazeWidgetLabel';
+    value: string;
+    mustInclude(...labels: Array<string | BlazeWidgetLabel>): BlazeWidgetLabel;
+    atLeastOneOf(...labels: Array<string | BlazeWidgetLabel>): BlazeWidgetLabel;
+    toString(): string;
+}
+export declare class BlazeWidgetLabel implements IBlazeWidgetLabel {
+    readonly _type: 'BlazeWidgetLabel';
     value: string;
     constructor(value: string);
     static singleLabel(label: string): BlazeWidgetLabel;
@@ -833,6 +844,7 @@ export declare const IMA_RATIOS: {
     readonly horizontal: "640x480";
     readonly vertical: "1080x1920";
 };
+export declare const BANNER_REFRESH_INTERVAL: number;
 
 export declare enum StoryAction {
     Start = "story_start",
@@ -1036,6 +1048,13 @@ export interface AppConfiguration {
     };
 }
 
+export type ContentExtraInfo = {
+    previous?: ExtraInfo;
+    current?: ExtraInfo;
+    next?: ExtraInfo;
+};
+export type ExtraInfo = Record<string, string>;
+
 export type ContentEntities = {
     gameId: string | null;
     teamId: string | null;
@@ -1053,6 +1072,7 @@ export interface IContent {
     entities?: ContentEntities;
     bannerAdInfo?: IBannerAdInfo;
     closedCaptions?: IClosedCaption[];
+    extraInfo: ExtraInfo;
 }
 
 export interface ICta {
@@ -1085,6 +1105,7 @@ export * from './thumbnail.interface';
 export * from './video.interface';
 export * from './entity.interface';
 export * from './app-configuration';
+export * from './content-extra-info';
 
 export type InteractionType = 'Poll' | 'Quiz' | 'Enrichment';
 type InteractionRelative = 'Player' | 'Screen';
@@ -1209,6 +1230,7 @@ interface IBasePage {
     hasViewed: boolean;
     ignoreReadStatusForStory: boolean;
     createTime: string;
+    extraInfo?: Record<string, string>;
 }
 export interface IContentPage extends IBasePage {
     type: 'Content';
@@ -1445,7 +1467,15 @@ export declare abstract class WidgetsFactory {
 
 export * from './elements.factory';
 
+export declare function isValidIds(ids: unknown): ids is string[];
+export declare function hasValidIds(...sources: Array<string[] | undefined>): boolean;
+
 export * from './widget-theme.guard';
+export * from './labels.guard';
+export * from './ids.guard';
+
+export declare function isValidLabels(labels: unknown): labels is string | string[] | IBlazeWidgetLabel;
+export declare function hasValidLabels(...sources: Array<string | string[] | IBlazeWidgetLabel | undefined>): boolean;
 
 export declare function isWidgetTheme(theme: any): theme is IWidgetTheme;
 
@@ -1487,11 +1517,11 @@ type CustomNativeArgs = {
     path: string;
 };
 export interface CustomNativeAdHandler {
-    provideAdExtraParams?: (args: CustomNativeArgs) => CustomNativeTargeting;
+    provideAdExtraParams?: (args: CustomNativeArgs, contentExtraInfo?: ContentExtraInfo) => CustomNativeTargeting;
 }
 type ImaExtraParams = Record<string, string>;
 export interface ImaAdHandler {
-    provideAdExtraParams?: () => ImaExtraParams;
+    provideAdExtraParams?: (contentExtraInfo?: ContentExtraInfo) => ImaExtraParams;
 }
 
 export interface ISmoothOpenCloseModal {
@@ -4172,6 +4202,7 @@ export declare abstract class BlazeWidgetContent extends HTMLElement {
     isNavigationPending: boolean;
     isPausedManually: boolean;
     resumeAfterfocus: boolean;
+    contentExtraInfo?: ContentExtraInfo;
     boundOnFocusEvent: () => void;
     boundOnBlurEvent: () => void;
     boundOnVisibilityChangeEvent: () => void;
@@ -4186,6 +4217,7 @@ export declare abstract class BlazeWidgetContent extends HTMLElement {
     setWidgetItemParent(item: BlazeWidgetItem): void;
     updateWidgetStatusReadUnread(): void;
     getRefferingObject(): ReferringEventInfo;
+    setContentExtraInfo(contentExtraInfo: ContentExtraInfo): void;
     render(): void;
 }
 
@@ -4600,6 +4632,7 @@ export declare abstract class WidgetAbstractPlayer extends BaseWidget {
     isBlazeWidgetStory(content: BlazeWidgetContent[]): content is BlazeWidgetStory[];
     isBlazeWidgetMoment(content: BlazeWidgetContent[]): content is BlazeWidgetMoment[];
     isBlazeWidgetVideo(content: BlazeWidgetContent[]): content is BlazeVideoElement[];
+    getContentExtraInfo(contents: BlazeWidgetContent[], index: number): ContentExtraInfo;
 }
 
 export declare class BlazeWidgetScrollable extends BaseWidget {
@@ -4776,7 +4809,7 @@ export declare class BlazeWidgetVideo extends BlazeWidgetVideoBase {
     render(): void;
     restartVideo(): void;
     initializeIMA(): Promise<void>;
-    buildImaUrl(iamData: IImaAdInfo, pageIndex?: number): Promise<string>;
+    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;
@@ -4841,13 +4874,19 @@ export declare class BlazeWidgetAd extends BlazeWidgetVideoBase {
 }
 
 export declare class BlazeWidgetBannerAd extends HTMLElement {
+    parentContnet: BlazeWidgetContent;
+    constructor(parentContent: BlazeWidgetContent);
     private adContainer;
+    private bannerAdInfo;
+    private isActive;
     private get googletag();
     connectedCallback(): void;
+    disconnectedCallback(): void;
     show(bannerAdInfo?: IBannerAdInfo): void;
     private setInitialStyles;
     private setAdContainer;
     private raiseAnalyticsEventToParent;
+    raiseAnalyticsViewBannerAd(): void;
 }
 
 export declare class BlazeWidgetVastAd extends HTMLElement {
@@ -4869,7 +4908,7 @@ export declare class BlazeWidgetVastAd extends HTMLElement {
     constructor(contentType: ContentType, getReferringObject?: (() => ReferringEventInfo) | undefined);
     private initializeGoogleIma;
     private buildImaUrl;
-    startAd(videoElement: HTMLVideoElement, tag: string): Boolean;
+    startAd(videoElement: HTMLVideoElement, tag: string, contentExtraInfo: ContentExtraInfo): Boolean;
     private onAdsManagerLoaded;
     private loadAds;
     private onAdEvent;
@@ -5134,6 +5173,7 @@ export declare class BlazeWidgetMoment extends BlazeWidgetContent {
         data: IMoment;
         shouldShowImaAdOnStart: boolean;
         adInfo?: IAdInfo;
+        contentExtraInfo?: ContentExtraInfo;
     }): Promise<void>;
     updateContent(momentContentData: MomentContentParams): void;
     updateLikeCount(likes?: number): Promise<void>;
@@ -5189,7 +5229,7 @@ export declare class BlazeWidgetStoryPlayer extends WidgetAbstractPlayer {
     applyStyles(): void;
     updateContentConfig(stories: IStory[]): void;
     attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
-    setContent(content: BlazeWidgetStory[]): void;
+    setContent(contents: BlazeWidgetStory[]): void;
     navigateContent(direction: ContentDirection): void;
     onFocus(): void;
     handleMoveSwipe(ev: HammerInput): void;
@@ -5273,6 +5313,7 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     requestAnimationId: number | null;
     shouldShowImaAdOnStart: boolean;
     bannerAdElement?: BlazeWidgetBannerAd;
+    lastBannerRefreshInWatchTimeMS: number;
     boundOnResumeEvent: () => void;
     boundOnPauseEvent: () => void;
     boundOnNextPageEvent: () => void;
@@ -5382,6 +5423,7 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     private onPauseEvent;
     private onNextPageEvent;
     private onPrevPageEvent;
+    private getPagesContentExtraInfo;
 }
 
 export declare const ElementId: {