@wscsports/blaze-web-sdk 0.1.737 → 0.1.751

package/package.json

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

package/publish/index.d.ts

@@ -109,7 +109,6 @@ export declare class URLManager {
     static isBackWasCalled: boolean;
     static resetLocation(): void;
     static updateLocationStoryHash(story?: IStory): void;
-    static getPlayerTypeFromUrl(): "Widget" | "Share" | "SingleStory" | undefined;
 }
 
 export declare class BlazeAlert extends BaseWidget {
@@ -263,8 +262,18 @@ export declare enum WidgetAction {
     Visible = "widget_visible",
     Click = "widget_click"
 }
+export declare enum AdAction {
+    View = "ad_view",
+    Exit = "ad_exit",
+    Click = "ad_click"
+}
+export declare const StoryToAdActionMapper: {
+    story_page_start: AdAction;
+    story_page_exit: AdAction;
+    cta_click: AdAction;
+};
 type ExposedFields = {
-    [key in StoryAction | WidgetAction]?: string[];
+    [key in StoryAction | WidgetAction | AdAction]?: string[];
 };
 export declare const exposedFieldsByAction: ExposedFields;
 
@@ -286,6 +295,16 @@ export declare class Database implements IDatabase {
 
 export * from './database';
 
+interface IAdInfoConfiguration {
+    adLocationsIndexes: Array<number>;
+    isActive: boolean;
+}
+export interface IAdInfo {
+    path: string;
+    type: string;
+    configuration: IAdInfoConfiguration;
+}
+
 export interface IContent {
     id: string;
     title: string;
@@ -333,7 +352,7 @@ export interface IMoment extends IContent {
     };
 }
 
-export interface IPage {
+export interface IContentPage {
     id: string;
     type: 'Content';
     index: number;
@@ -346,6 +365,16 @@ export interface IPage {
     ignoreReadStatusForStory: boolean;
     createTime: string;
 }
+export interface IAdPage {
+    id: string;
+    type: 'Ad';
+    duration: number;
+    hasViewed: boolean;
+    ignoreReadStatusForStory: boolean;
+    createTime: string;
+    adPath: string;
+}
+export type IPage = IAdPage | IContentPage;
 
 export interface IRendition {
     url: string;
@@ -356,6 +385,7 @@ export interface IStory extends IContent {
     isLive: boolean;
     pages: IPage[];
     isAd: boolean;
+    adInfo?: IAdInfo;
 }
 
 export interface IThumbnail {
@@ -398,6 +428,7 @@ export * from './event.enum';
 
 export interface WidgetsTagNameMap {
     'blaze-sdk': BlazeWidgetSDK;
+    'blaze-widget-ad': BlazeWidgetStoryAd;
     'blaze-widget-modal': BlazeWidgetModal;
     'blaze-widget-item': BlazeWidgetItem;
     'blaze-widget-layout': BlazeWidgetLayout;
@@ -425,6 +456,7 @@ export interface WidgetsTagNameMap {
 }
 interface WidgetsTagNameOptionsMap {
     'blaze-sdk': {};
+    'blaze-widget-ad': {};
     'blaze-widget-modal': {};
     'blaze-widget-item': {};
     'blaze-widget-layout': {};
@@ -495,6 +527,7 @@ export interface IBlazeSDKOptions {
     doNotTrack?: boolean;
     externalUserId?: string;
     geoLocation?: string;
+    loadByStaticContent?: boolean;
 }
 
 export interface IDatabase {
@@ -574,6 +607,17 @@ export interface IWidgetView {
     setDelegations: (delegates: Record<Delegation, EventListenerOrEventListenerObject>) => void;
 }
 
+declare const AdServiceClass_base: {
+    new (): {};
+    _instance: AdServiceClass;
+    getInstance(): AdServiceClass;
+};
+declare abstract class AdServiceClass extends AdServiceClass_base implements IService {
+    canRunAds: boolean;
+    init(): Promise<void>;
+}
+export declare const AdService: AdServiceClass;
+
 declare const AlertServiceClass_base: {
     new (): {};
     _instance: AlertServiceClass;
@@ -585,16 +629,6 @@ declare abstract class AlertServiceClass extends AlertServiceClass_base implemen
 }
 export declare const AlertService: AlertServiceClass;
 
-export declare enum AdAction {
-    Request = "ad_request",
-    Load = "ad_load",
-    Insert = "ad_insert",
-    View = "ad_view",
-    Click = "ad_click",
-    Exit = "ad_exit",
-    Pause = "ad_playback_pause",
-    Play = "ad_playback_play"
-}
 export declare enum SessionAction {
     Start = "start",
     End = "end"
@@ -611,6 +645,7 @@ declare abstract class AnalyticsServiceClass extends AnalyticsServiceClass_base
     bulkEvent(body: Partial<AnalyticsEvent>[]): Promise<any>;
     pushSessionEvent(action: SessionAction, body: Partial<WidgetEvent>, label?: string | undefined): void;
     pushStoryEvent(action: StoryAction, body: Partial<StoryEvent>, label?: string | undefined, referrer?: ReferringEventInfo | undefined): void;
+    pushAdEvent(action: AdAction, body: Partial<AdEvent>, label?: string | undefined, referrer?: ReferringEventInfo | undefined): void;
     pushWidgetEvent(action: WidgetAction, body: Partial<WidgetEvent>, label?: string | undefined, referrer?: ReferringEventInfo | undefined): void;
     setupEvent(category: Category, action: string, body: object, label?: string | undefined, referrer?: ReferringEventInfo | undefined): AnalyticsEvent;
 }
@@ -618,6 +653,7 @@ export declare const AnalyticsService: AnalyticsServiceClass;
 export declare enum Category {
     Story = "story",
     Widget = "widget",
+    Ad = "ad",
     Session = "session"
 }
 declare class UserEventInfo {
@@ -700,6 +736,7 @@ export declare class AnalyticsEvent {
     'referring': ReferringEventInfo;
     story: Partial<StoryEvent> | undefined;
     widget: Partial<WidgetEvent> | undefined;
+    ad: Partial<AdEvent> | undefined;
 }
 export declare class StoryEvent {
     'story_start_id': string;
@@ -746,6 +783,26 @@ export declare class WidgetEvent {
     'page_type': string;
     'page_size': string;
 }
+export declare class AdEvent {
+    'advertiser_id': string;
+    'advertiser_name': string;
+    'campaign_id': string;
+    'campaign_name': string;
+    'ad_server': string;
+    'story_id': string;
+    'story_title': string;
+    'ad_insertion_logic': string;
+    'ad_index': string;
+    'ad_start_trigger': string;
+    'ad_exit_trigger': string;
+    'ad_duration': string;
+    'ad_duration_viewed_percent': string;
+    'playback_action_method': string;
+    'audio_state': string;
+    'skip_config': string;
+    'content_type': string;
+    'ad_path': string;
+}
 
 declare const ApiServiceClass_base: {
     new (): {};
@@ -755,21 +812,31 @@ declare const ApiServiceClass_base: {
 declare abstract class ApiServiceClass extends ApiServiceClass_base implements IService {
     api: API;
     init(): Promise<void>;
-    getStoriesByIds(storyIds: string[], orderType?: OrderType): Promise<IResponse<{
-        assetsExpiryTime: string;
-        totalItems: number;
+    private setAdsOnStories;
+    getStoriesByIds(storyIds: string[], orderType?: OrderType): Promise<{
         result: IStory[];
-    }>>;
-    getStories(labels: string, orderType: OrderType, maxItemsSize?: number): Promise<IResponse<{
-        assetsExpiryTime: string;
-        totalItems: number;
+        data: {
+            assetsExpiryTime: string;
+            totalItems: number;
+            result: IStory[];
+        };
+        error?: Error | undefined;
+    }>;
+    getStories(labels: string, orderType: OrderType, maxItemsSize?: number): Promise<{
         result: IStory[];
-    }>>;
+        data: {
+            assetsExpiryTime: string;
+            totalItems: number;
+            result: IStory[];
+        };
+        error?: Error | undefined;
+    }>;
     getShorts(labels: string, orderType: OrderType, maxItemsSize?: number): Promise<IResponse<{
         assetsExpiryTime: string;
         totalItems: number;
         result: IMoment[];
     }>>;
+    getStaticStories(): Promise<IStory | null>;
     preview(storyId: string, publishedOnly?: boolean): Promise<IResponse<IStory & {
         status: number;
     }>>;
@@ -794,6 +861,7 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     private _doNotTrack;
     private _externalUserId;
     private _geoLocation;
+    private _staticContent;
     protected constructor();
     init(options: IBlazeSDKOptions): Promise<void>;
     private _urls;
@@ -809,6 +877,8 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     set doNotTrack(value: boolean);
     get geoLocation(): string;
     set geoLocation(value: string);
+    get staticContent(): boolean;
+    set staticContent(value: boolean);
     get apiUrl(): string;
     get apiKey(): string;
     get previewUrl(): string;
@@ -1570,6 +1640,37 @@ export * from './widget-story-player';
 export * from './widget-story-preview';
 export * from './widget-story-video';
 
+export declare class BlazeWidgetStoryAd extends BlazeWidgetStoryBase {
+    data: IPage | undefined;
+    private isCurrectlyDisplay;
+    private adContainer;
+    private placeholderContainer;
+    private googletag;
+    private isMuted;
+    private failToLoadTimeout?;
+    constructor(storyParent: BlazeWidgetStory);
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    render(): void;
+    get currentTime(): number;
+    set currentTime(value: number);
+    get duration(): number;
+    get progress(): number;
+    set muted(isMuted: boolean);
+    getAdIframeRef(): HTMLIFrameElement | null;
+    changeAdMutedState(isMuted: boolean): void;
+    setData(data: IPage): void;
+    play(): void;
+    get paused(): boolean;
+    pause(): void;
+    removeLoader(): void;
+    loadPoster(): void;
+    hide(): void;
+    display(onFail?: () => void): void;
+    mainElement(): CanvasImageSource;
+    private initStyles;
+}
+
 export interface BlazeWidgetItemOptions {
     theme: IWidgetTheme;
     content: IStory;
@@ -1843,7 +1944,7 @@ export declare class BlazeWidgetScrollable extends BaseWidget {
 }
 
 export declare class BlazeWidgetSDK extends BaseWidget {
-    modalStoryIds: BlazeWidgetStoryModal | undefined;
+    modalStory: BlazeWidgetStoryModal | undefined;
     onResizeEvent: (this: Window, ev: UIEvent) => void;
     static get observedAttributes(): string[];
     constructor();
@@ -1851,10 +1952,13 @@ export declare class BlazeWidgetSDK extends BaseWidget {
     disconnectedCallback(): void;
     onResize(): void;
     loadStoriesByHash(storyIds: string): Promise<void>;
+    loadStoriesByStaticContent(): Promise<void>;
     attributeChangedCallback(name: string, oldValue: string, newValue: string): Promise<void>;
     private getConfigAttributes;
     private initialize;
+    private injectToHead;
     private injectFontResource;
+    private injectGoogleTag;
 }
 
 export interface IShareButton {
@@ -1894,7 +1998,7 @@ export declare class BlazeWidgetStoryBase extends HTMLElement {
     removeLoader(): any;
     load(): void;
     unload(): void;
-    display(): void;
+    display(onFail?: () => void): void;
     hide(): void;
     set muted(value: boolean);
     get duration(): number;
@@ -2008,7 +2112,7 @@ export declare class BlazeWidgetStoryPlayer extends BaseWidget {
     goNext(): void;
     handleAnimation(distance: number, story: BlazeWidgetStory, currentAnimation?: AnimeInstance | null): void;
     onSmallGestures(currentAnimation: AnimeInstance, currentStory: BlazeWidgetStory): void;
-    onKeyDown(ev: KeyboardEvent): boolean;
+    onKeyDown(ev: KeyboardEvent): false | undefined;
     render(): void;
 }
 
@@ -2142,7 +2246,7 @@ export declare class BlazeWidgetStory extends HTMLElement {
     widgetParent: BlazeWidgetItem;
     playCallback: any;
     sessionId: string;
-    startTrigger: 'Widget' | 'Deeplink' | 'Swipe' | 'Skip' | '';
+    startTrigger: 'Widget' | 'Deeplink' | 'Swipe' | 'Skip' | 'Static Load' | '';
     exitTrigger: 'Swipe' | 'Swipe Down' | 'Skip' | 'Close Button' | 'CTA Click' | 'Escape Button' | '';
     navigationType: 'Automatic' | 'Manual' | undefined;
     navigationDirection: 'Forwards' | 'Backwards' | undefined;
@@ -2156,10 +2260,13 @@ export declare class BlazeWidgetStory extends HTMLElement {
     isNavigationPending: boolean;
     navigationTimeout: NodeJS.Timeout | null;
     lastPageIndexToResume: number;
+    elementsToHideOnAds: HTMLElement[];
+    muteStateBeforeAd: 'mute' | 'unmute' | 'no-ad';
     constructor();
     onShareClick(): Promise<void>;
     updateChip(): void;
     setTheme(storyPlayerStyle: StoryPlayerStyle): void;
+    adjustAdView(): void;
     updatePlayerButtonIcons(): void;
     onCtaClick(event: Event): boolean;
     playToggle(): void;
@@ -2181,7 +2288,7 @@ export declare class BlazeWidgetStory extends HTMLElement {
     removeFromCache(): void;
     load(): void;
     play(): void;
-    event(action: StoryAction, data: Partial<StoryEvent>, label?: string | undefined): void;
+    event(action: StoryAction, storyData: Partial<StoryEvent>, label?: string | undefined): void;
     connectedCallback(): void;
     onShareModalClose(): void;
     onShareModalButtonClick(shareButton: BlazeShareButton): Promise<void>;