@wscsports/blaze-web-sdk 0.1.72 → 0.1.76

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wscsports/blaze-web-sdk",
-  "version": "0.1.72",
+  "version": "0.1.76",
   "main": "publish/index",
   "types": "publish/index",
   "files": [
@@ -16,7 +16,6 @@
   "devDependencies": {
     "@types/animejs": "^3.1.7",
     "@types/hammerjs": "^2.0.41",
-    "@types/lodash": "^4.14.195",
     "@types/ua-parser-js": "^0.7.36",
     "css-loader": "^6.8.1",
     "html-webpack-plugin": "^5.5.3",
@@ -33,6 +32,7 @@
   "dependencies": {
     "animejs": "^3.2.1",
     "hammerjs": "^2.0.8",
+    "intersection-observer": "^0.12.2",
     "ua-parser-js": "^1.0.36"
   }
 }

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 {
@@ -667,6 +703,7 @@ export declare class ReferringEventInfo {
     'referrer_page_type': string;
     'referrer_page_url': string;
     'referrer_page_domain': string;
+    'labels_expression': string;
     'session_referrer_page_type': string;
     'session_referrer_url': string;
     'session_referrer_domain': string;
@@ -700,6 +737,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;
@@ -718,10 +756,11 @@ export declare class StoryEvent {
     'content_duration_viewed': number;
     'story_page_duration': number;
     'story_page_duration_viewed_percent': number;
+    'labels_expression': string;
     'story_session_id': string;
     'story_page_index': number;
     'is_last_page': boolean;
-    'audio_state': boolean;
+    'audio_state': string;
     'playback_action_method': 'Press' | 'Release' | 'Click';
 }
 export declare class WidgetEvent {
@@ -735,6 +774,7 @@ export declare class WidgetEvent {
     'widget_size': string;
     'widget_content_count': number;
     'widget_content_list': string;
+    'labels_expression': string;
     'content_id': string;
     'content_name': string;
     'content_version_id': string;
@@ -746,6 +786,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 +815,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 +864,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 +880,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;
@@ -1462,12 +1535,9 @@ export type OrderType = 'Manual' | 'AtoZ' | 'ZtoA' | 'RecentlyUpdatedFirst' | 'R
 export declare const PlayTypeArray: readonly ["Widget", "Share", "SingleStory"];
 export type PlayType = typeof PlayTypeArray[number];
 
-export type PositionInsideType = 'insideTopLeft' | 'insideTopRight' | 'insideMiddle' | 'insideBottomRight' | 'insideBottomLeft' | 'insideBottomMiddle' | 'insideMiddleLeft' | 'insideMiddleRight';
+export type PositionInsideType = 'insideTopLeft' | 'insideTopRight' | 'insideMiddleTop' | 'insideMiddle' | 'insideBottomRight' | 'insideBottomLeft' | 'insideBottomMiddle' | 'insideMiddleLeft' | 'insideMiddleRight';
 export type PositionOutsideType = 'outsideUnder' | 'outsideBelow' | 'outsideAbove' | 'outsideTop' | 'outsideTopLeft' | 'outsideTopRight' | 'outsideBottomLeft' | 'outsideBottomRight' | 'outsideBottom' | 'outsideRight' | 'outsideLeft';
 export type PositionType = PositionInsideType | PositionOutsideType;
-export type PositionCircleRowLabelType = 'outsideBelow' | 'outsideAbove';
-export type PositionRectangleRowLabelType = PositionCircleRowLabelType | PositionInsideType;
-export type PositionRectangleRowHorizontalLabelType = PositionInsideType;
 
 export type SeverityType = 'error' | 'warning' | 'info' | 'success';
 
@@ -1475,10 +1545,10 @@ export type SizeType = 'small' | 'medium' | 'large';
 
 export type ThumbnailApiType = 'SquareIcon' | 'VerticalTwoByThree' | 'MainThumbnail';
 export type ThumbnailType = 'SQUARE_ICON' | 'VERTICAL_TWO_BY_THREE' | 'CUSTOM';
-export type ThumbnailShape = 'circle' | 'rectangle';
+export type ThumbnailShape = 'Circle' | 'Rectangle';
 export declare function thumbnailMapping(thumbnailType: ThumbnailType): ThumbnailApiType;
 
-export type WidgetType = 'row' | 'grid';
+export type WidgetType = 'Row' | 'Grid';
 
 interface ChipSizeOptions {
     statusLiveStyle: IndicatorStyle;
@@ -1487,6 +1557,11 @@ interface ChipSizeOptions {
     statusUnreadStyle: IndicatorStyle;
 }
 export declare function getChipSize(options: ChipSizeOptions): DOMRect;
+export declare function getMaxChipSize(layout: LayoutStyle): DOMRect;
+export declare function calculateChipSize(statusIndicatorPosition: PositionType, layoutStyle: LayoutStyle): {
+    chipHeight: number;
+    chipWidth: number;
+};
 
 export declare function delay(ms: number): Promise<void>;
 
@@ -1522,6 +1597,19 @@ export * from './guard.utils';
 export * from './helper';
 export * from './regex.utils';
 export * from './stopwatch';
+export * from './position.utils';
+
+export declare function calculatePosition(statusIndicatorPosition: PositionType): {
+    isOutside: boolean;
+    isInside: boolean;
+    isTop: boolean;
+    isMiddle: boolean;
+    isBottom: boolean;
+    isBelow: boolean;
+    isAbove: boolean;
+    isLeft: boolean;
+    isRight: boolean;
+};
 
 export declare const RegexHash: RegExp;
 export declare const RegexHashPlayType: RegExp;
@@ -1555,6 +1643,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;
@@ -1598,11 +1717,6 @@ export declare class BlazeWidgetItem extends BaseWidget {
     private updateInsideLabelStyles;
     private updateOutsideLabelStyles;
     private updateThumbnailStyles;
-    getMaxChipSize(): DOMRect;
-    get chipDimenssions(): {
-        chipWidth: number;
-        chipHeight: number;
-    };
     private updateChipStyles;
     setTheme(theme: IWidgetTheme): void;
     setChipStyle(): void;
@@ -1634,14 +1748,17 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     preset: IWidgetTheme | undefined;
     thumbnailWidth: number | undefined;
     thumbnailHeight: number | undefined;
+    widgetHeight: number;
+    parentHeight: number | undefined;
+    intersectionObserver: IntersectionObserver;
+    heightObserver: MutationObserver;
     reloadTimeout: NodeJS.Timeout | undefined;
     analyticsStack: Record<WidgetAction, boolean>;
-    intersectionObserver: IntersectionObserver;
     onResizeEvent: (this: Window, ev: UIEvent) => void;
-    isWidgetReload: boolean | undefined;
-    widgetHeight: number;
     constructor();
+    handleHeightChangeMutation(mutationsList: MutationRecord[]): void;
     connectedCallback(): void;
+    getParentHeightWithoutPadding(): number | null;
     disconnectedCallback(): void;
     set storyIds(value: string);
     setContentIds(storyIds: string[]): void;
@@ -1665,6 +1782,11 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     loadStories(): Promise<void>;
     private get theme();
     render(): void;
+    calculateLabelSizes(labelStyle: LabelStyle, lineNumber: number): {
+        labelWidth: number | "auto";
+        labelAdditionalWidth: number;
+        labelAdditionalHeight: number;
+    };
     maxSize(): number;
     event(action: WidgetAction, data: Partial<WidgetEvent>, label?: string | undefined): void;
     isReadByLastUnIgnoredPageStatus(story: IStory): boolean;
@@ -1672,7 +1794,6 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     reorderWidgets(): void;
     connectWidgets(): void;
     get thumbnailShape(): ThumbnailShape;
-    getMaxChipSize(): DOMRect;
     widgetType(): WidgetType;
 }
 
@@ -1826,7 +1947,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();
@@ -1834,10 +1955,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 {
@@ -1877,7 +2001,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;
@@ -1991,7 +2115,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;
 }
 
@@ -2125,7 +2249,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;
@@ -2139,10 +2263,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;
@@ -2164,7 +2291,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>;