@wscsports/blaze-web-sdk 0.2.9 → 0.3.0

package/package.json

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

package/publish/index.d.ts

@@ -180,6 +180,7 @@ export declare class StoryEvent {
     'audio_state': string;
     'playback_action_method': PlaybackActionType;
     'player_type': PlayerType;
+    'player_orientation': ContentAspectRatio;
 }
 export declare class MomentEvent {
     'moments_session_id': string;
@@ -238,6 +239,8 @@ export declare class AdEvent {
     'skip_config': string;
     'content_type': string;
     'ad_path': string;
+    'ad_unit_id': string;
+    'session_id': string;
 }
 export declare class ImaAdEvent {
     'story_id': string;
@@ -577,6 +580,12 @@ export declare class BlazeShareButton extends BaseWidget {
     createButton(text: string, svgIcon: string): void;
 }
 
+export declare const IMA_RATIOS: {
+    readonly general: "1x1";
+    readonly horizontal: "640x480";
+    readonly vertical: "1080x1920";
+};
+
 export declare enum StoryAction {
     Start = "story_start",
     Exit = "story_exit",
@@ -614,7 +623,10 @@ export declare enum WidgetAction {
 export declare enum AdAction {
     View = "ad_view",
     Exit = "ad_exit",
-    Click = "ad_click"
+    Click = "ad_click",
+    BannerView = "banner_ad_view",
+    BannerLoad = "banner_ad_load",
+    BannerClick = "banner_ad_click"
 }
 export declare enum ImaAdAction {
     ALL_ADS_COMPLETED = "ima_all_ads_completed",
@@ -665,6 +677,7 @@ export declare const ASPECT_RATIO_16_9_STRING = "16 / 9";
 export declare const ASPECT_RATIO_9_16_STRING = "9 / 16";
 export declare const ASPECT_RATIO_4_3_STRING = "4 / 3";
 
+export * from './ads.constants';
 export * from './analytics.constants';
 export * from './device.constants';
 export * from './iso-country-codes.constants';
@@ -708,7 +721,13 @@ export interface IAdInfo {
     configuration?: IAdInfoConfiguration;
     context?: IAdContext;
 }
+export interface IBannerAdInfo {
+    adUnitId: string;
+    size: 'Banner';
+    type: 'Banner';
+}
 
+export type ContentAspectRatio = 'Vertical' | 'Horizontal';
 export interface IContent {
     id: string;
     title: string;
@@ -723,6 +742,7 @@ export interface IContent {
         teamId: string | null;
         playerId: string | null;
     };
+    bannerAdInfo?: IBannerAdInfo;
 }
 
 export interface ICTA {
@@ -844,6 +864,7 @@ export type IPage = IAdPage | IContentPage;
 
 export interface IRendition {
     url: string;
+    aspectRatio: ContentAspectRatio;
 }
 
 export interface IStory extends IContent {
@@ -856,6 +877,7 @@ export interface IStory extends IContent {
 export interface IThumbnail {
     type: 'SquareIcon' | 'VerticalTwoByThree' | 'MainThumbnail' | 'PosterPortrait';
     rendition: IRendition;
+    renditions?: IRendition[];
 }
 
 export declare enum ErrorCode {
@@ -893,7 +915,14 @@ export declare enum InternalEvent {
     PREV_STORY = "prev_story",
     FULL_SCREEN_CLICK = "full_screen_click",
     AD_ENDED = "ad_ended",
-    AD_RESUMED = "ad_resumed"
+    AD_RESUMED = "ad_resumed",
+    BANNER_ANALYTICS = "banner_analytics"
+}
+export interface InternalEventDetails {
+    [InternalEvent.BANNER_ANALYTICS]: {
+        type: AdAction;
+        adUnitId: string;
+    };
 }
 
 export declare const HttpStatus: {
@@ -929,6 +958,7 @@ export interface WidgetsTagNameMap {
     'blaze-widget-cta-modal': BlazeWidgetCtaModal;
     'blaze-widget-video': BlazeWidgetVideo;
     'blaze-widget-interaction': BlazeWidgetInteraction;
+    'blaze-widget-banner-ad': BlazeWidgetBannerAd;
     'blaze-loader': BlazeLoader;
     'blaze-chip': BlazeChip;
     'blaze-image': BlazeImage;
@@ -960,6 +990,7 @@ interface WidgetsTagNameOptionsMap {
     'blaze-widget-video': {};
     'blaze-widget-moment-video': {};
     'blaze-widget-interaction': {};
+    'blaze-widget-banner-ad': {};
     'blaze-loader': {};
     'blaze-chip': {};
     'blaze-image': {};
@@ -1049,6 +1080,7 @@ export interface IBlazeSDKOptions {
     shouldCreateUser?: boolean;
     externalUserId?: string | null;
     prefetchingPolicy?: PrefetchingPolicyType;
+    shouldAllowHorizontalStories?: boolean;
 }
 
 export interface IButtonPlayerNavigationConfig {
@@ -1364,6 +1396,7 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     private _shouldCreateUser;
     private _externalUserId;
     private _prefetchingPolicy;
+    private _shouldAllowHorizontalStories;
     protected constructor();
     init(options: IBlazeSDKOptions): Promise<void>;
     private _urls;
@@ -1378,6 +1411,7 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     set externalUserId(value: string | null);
     get doNotTrack(): boolean;
     set doNotTrack(value: boolean);
+    get shouldAllowHorizontalStories(): boolean;
     get geoLocation(): string;
     set geoLocation(value: string);
     get staticContent(): boolean;
@@ -2449,6 +2483,7 @@ export declare class Stopwatch {
 export * from './widget-video-base';
 export * from './widget-player';
 export * from './ad/widget-ad';
+export * from './ad/widget-banner-ad';
 export * from './widget-embedded-story';
 export * from './widget-interaction';
 export * from './widget-item';
@@ -2485,6 +2520,7 @@ export declare abstract class BlazeWidgetContent extends HTMLElement {
     widgetParentItem: BlazeWidgetItem;
     sessionId: string;
     refContentModal?: BlazeWidgetStoryModal | BlazeWidgetMomentModal;
+    abstract aspectRatio?: ContentAspectRatio;
     constructor();
     connectedCallback(): void;
     disconnectedCallback(): void;
@@ -3080,6 +3116,16 @@ export declare class BlazeWidgetAd extends BlazeWidgetVideoBase {
     private destroyAd;
 }
 
+export declare class BlazeWidgetBannerAd extends HTMLElement {
+    private adContainer;
+    private get googletag();
+    connectedCallback(): void;
+    show(bannerAdInfo?: IBannerAdInfo): void;
+    private setInitialStyles;
+    private setAdContainer;
+    private raiseAnalyticsEventToParent;
+}
+
 export type BlazeWidgetContentType = BlazeWidgetMoment[] & BlazeWidgetStory[];
 export declare class BlazeWidgetMomentModal extends BlazeWidgetModal {
     parentWidget: HTMLElement;
@@ -3222,6 +3268,7 @@ interface MomentContentParams {
 export declare class BlazeWidgetMoment extends BlazeWidgetContent {
     playerStyle?: MomentPlayerStyle | undefined;
     video?: BlazeWidgetVideo | BlazeWidgetAd;
+    aspectRatio?: ContentAspectRatio | undefined;
     modal: BlazeWidgetMomentModal;
     seekBar: BlazeWidgetMomentSeekBar;
     shareModal: BlazeWidgetShareModal | undefined;
@@ -3383,6 +3430,7 @@ export declare class BlazeWidgetStoryPlayer extends WidgetAbstractPlayer {
 export declare class BlazeWidgetStory extends BlazeWidgetContent {
     playerStyle: StoryPlayerStyle;
     mode: ScreenMode;
+    aspectRatio?: ContentAspectRatio;
     pages: BlazeWidgetVideoBase[];
     data: IStory;
     shareModal: BlazeWidgetShareModal | undefined;
@@ -3434,6 +3482,7 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     shouldShowImaAdOnStart: boolean;
     imaUrl: string;
     adContext?: IAdContext;
+    bannerAdElement?: BlazeWidgetBannerAd;
     constructor(playerStyle: StoryPlayerStyle, mode: ScreenMode);
     private isButtonVisible;
     private createPlayerButtonsAndAppendToButtonsContainer;
@@ -3469,6 +3518,7 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     displayCurrentStoryPageAndHideTheRest(): void;
     load(): void;
     play(): void;
+    bannerAdEvent(detail: InternalEventDetails[InternalEvent.BANNER_ANALYTICS]): void;
     event(action: StoryAction, storyData: Partial<StoryEvent>, label?: string | undefined): void;
     updateContainerLayout(): void;
     connectedCallback(): void;