@wscsports/blaze-web-sdk 0.1.71 → 0.1.75

package/package.json

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

package/publish/index.d.ts

@@ -1,4 +1,5 @@
 export declare function setDoNotTrack(value: boolean): void;
+export declare function setGeoLocation(value: string): void;
 export declare function setExternalUserId(value: string): void;
 export declare function Initialize(apiKey: string, options?: Omit<IBlazeSDKOptions, "apiKey">): Promise<void>;
 export declare function WidgetRowView(containerId: string, options: IWidgetViewOptions): IWidgetView;
@@ -14,6 +15,7 @@ declare const _default: {
     Theme: typeof Theme;
     addDelegateListener: typeof addDelegateListener;
     setDoNotTrack: typeof setDoNotTrack;
+    setGeoLocation: typeof setGeoLocation;
     LabelBuilder: typeof LabelBuilder;
     Delegations: typeof Delegation;
 };
@@ -261,12 +263,25 @@ 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;
 
 export * from './analytics.constants';
+export * from './iso-country-codes.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 declare class Database implements IDatabase {
     private readonly options;
@@ -281,6 +296,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;
@@ -328,7 +353,7 @@ export interface IMoment extends IContent {
     };
 }
 
-export interface IPage {
+export interface IContentPage {
     id: string;
     type: 'Content';
     index: number;
@@ -339,7 +364,18 @@ export interface IPage {
     cta: ICTA;
     hasViewed: boolean;
     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;
@@ -350,6 +386,7 @@ export interface IStory extends IContent {
     isLive: boolean;
     pages: IPage[];
     isAd: boolean;
+    adInfo?: IAdInfo;
 }
 
 export interface IThumbnail {
@@ -392,6 +429,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;
@@ -419,6 +457,7 @@ export interface WidgetsTagNameMap {
 }
 interface WidgetsTagNameOptionsMap {
     'blaze-sdk': {};
+    'blaze-widget-ad': {};
     'blaze-widget-modal': {};
     'blaze-widget-item': {};
     'blaze-widget-layout': {};
@@ -488,6 +527,7 @@ export interface IBlazeSDKOptions {
     previewMomentUrl?: string;
     doNotTrack?: boolean;
     externalUserId?: string;
+    geoLocation?: string;
 }
 
 export interface IDatabase {
@@ -567,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;
@@ -578,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"
@@ -604,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;
 }
@@ -611,6 +653,7 @@ export declare const AnalyticsService: AnalyticsServiceClass;
 export declare enum Category {
     Story = "story",
     Widget = "widget",
+    Ad = "ad",
     Session = "session"
 }
 declare class UserEventInfo {
@@ -693,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;
@@ -714,7 +758,7 @@ export declare class StoryEvent {
     '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 {
@@ -739,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 (): {};
@@ -748,16 +812,25 @@ 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;
@@ -786,6 +859,7 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     private _sendAnaltyics;
     private _doNotTrack;
     private _externalUserId;
+    private _geoLocation;
     protected constructor();
     init(options: IBlazeSDKOptions): Promise<void>;
     private _urls;
@@ -799,6 +873,8 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     set externalUserId(value: string);
     get doNotTrack(): boolean;
     set doNotTrack(value: boolean);
+    get geoLocation(): string;
+    set geoLocation(value: string);
     get apiUrl(): string;
     get apiKey(): string;
     get previewUrl(): string;
@@ -1452,12 +1528,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';
 
@@ -1465,10 +1538,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;
@@ -1477,9 +1550,17 @@ 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>;
 
+type CountryCode = typeof CountryCodes[number];
+export declare function isValidCountryCode(countryCode: string): countryCode is CountryCode;
+
 export declare function GuardNullOrEmpty(name: string, value: any): void;
 
 export declare function formatDuration(startDate: Date): string;
@@ -1504,10 +1585,24 @@ export declare function flattenObject<T extends Record<string, any>>(obj: T): Re
 
 export * from './chip.utils';
 export * from './common.utils';
+export * from './country-location.utils';
 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;
@@ -1541,6 +1636,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;
@@ -1584,11 +1710,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;
@@ -1620,14 +1741,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;
@@ -1651,6 +1775,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;
@@ -1658,7 +1787,6 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     reorderWidgets(): void;
     connectWidgets(): void;
     get thumbnailShape(): ThumbnailShape;
-    getMaxChipSize(): DOMRect;
     widgetType(): WidgetType;
 }
 
@@ -1823,7 +1951,9 @@ export declare class BlazeWidgetSDK extends BaseWidget {
     attributeChangedCallback(name: string, oldValue: string, newValue: string): Promise<void>;
     private getConfigAttributes;
     private initialize;
+    private injectToHead;
     private injectFontResource;
+    private injectGoogleTag;
 }
 
 export interface IShareButton {
@@ -1863,7 +1993,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;
@@ -2125,10 +2255,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;
@@ -2150,7 +2283,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>;