@wscsports/blaze-web-sdk 0.4.2 → 0.4.4-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wscsports/blaze-web-sdk",
-  "version": "0.4.2",
+  "version": "0.4.4-beta.0",
   "main": "publish/index",
   "types": "publish/index",
   "files": [

package/publish/index.d.ts

@@ -1,7 +1,7 @@
 type PlayContentOptions = {
     dataSource: BlazeDataSourceType;
     actionHandlers?: ActionHandler[];
-    style?: StoryPlayerStyle | VideoPlayerStyle;
+    style?: StoryPlayerStyle | VideoPlayerStyle | MomentPlayerStyle;
 };
 export declare function setDoNotTrack(value: boolean): void;
 export declare function setGeoLocation(value: string): void;
@@ -27,6 +27,7 @@ export declare function playStories(dataSource: BlazeDataSourceType, style?: Sto
 export declare function playContent(contentType: ContentType, options: PlayContentOptions): Promise<void>;
 export declare function setAbTestParams(abTestParams: BlazeAbTestType): void;
 export declare function getAppContextManager(): Record<string, any>;
+export declare const pushConsentEvent: (action: string, body: Record<string, any>) => void;
 declare const _default: {
     Initialize: typeof Initialize;
     WidgetGridView: typeof WidgetGridView;
@@ -49,6 +50,7 @@ declare const _default: {
     playContent: typeof playContent;
     setAbTestParams: typeof setAbTestParams;
     getAppContextManager: typeof getAppContextManager;
+    pushConsentEvent: (action: string, body: Record<string, any>) => void;
 };
 export default _default;
 
@@ -80,7 +82,8 @@ export declare enum Category {
     Widget = "widget",
     Video = "video",
     Ad = "ad",
-    Interaction = "interaction"
+    Interaction = "interaction",
+    Consent = "consent"
 }
 declare class UserEventInfo {
     'generated_user_id': string;
@@ -170,6 +173,7 @@ export declare class AnalyticsEvent {
     video: Partial<VideoEvent> | undefined;
     ad: Partial<AdEvent> | undefined;
     interaction: Partial<InteractionEvent> | undefined;
+    consent: Partial<ConsentEvent> | undefined;
 }
 export declare class StoryEvent {
     'story_start_id': string;
@@ -326,6 +330,8 @@ export declare class InteractionEvent {
     'audio_state': string;
     'content_extra_info': string;
 }
+export declare class ConsentEvent {
+}
 
 export declare abstract class BaseWidget extends HTMLElement {
     protected _animationDuration: number;
@@ -825,7 +831,8 @@ export declare enum VideoAction {
 export declare enum WidgetAction {
     Load = "widget_load",
     Visible = "widget_visible",
-    Click = "widget_click"
+    Click = "widget_click",
+    SDKInit = "sdk_init"
 }
 export declare enum AdAction {
     Requested = "ad_requested",
@@ -1325,16 +1332,6 @@ export declare abstract class WidgetsFactory {
 }
 
 export * from './elements.factory';
-export * from './player.factory';
-
-export declare class PlayerViewFactory {
-    static create(type: ContentType, dataSource: BlazeDataSourceType, options: {
-        style: StoryPlayerStyle | VideoPlayerStyle;
-        actionHandlers?: ActionHandler[];
-    }): Promise<void>;
-    static createStory(dataSource: BlazeDataSourceType, style: StoryPlayerStyle, actionHandlers?: ActionHandler[]): Promise<void>;
-    static createVideos(dataSource: BlazeDataSourceType, style: VideoPlayerStyle): Promise<void>;
-}
 
 export * from './widget-theme.guard';
 
@@ -1411,6 +1408,7 @@ export interface IBlazeSDKOptions {
     autoAdvanceUrl?: string;
     layoutDirection?: LocaleDirectionType;
     shouldAllowClosedCaptions?: boolean;
+    disableAutoLoadingContent?: boolean;
 }
 
 export interface IButtonPlayerNavigationConfig {
@@ -1647,6 +1645,7 @@ declare abstract class AnalyticsServiceClass extends AnalyticsServiceClass_base
     pushMomentEvent(action: MomentAction, body: Partial<MomentEvent>, label?: string | undefined, referrer?: ReferringEventInfo | undefined): void;
     pushVideoEvent(action: VideoAction, body: Partial<VideoEvent>, label?: string | undefined, referrer?: ReferringEventInfo | undefined): void;
     pushAdEvent(action: AdAction, body: Partial<AdEvent>, label?: string | undefined, referrer?: ReferringEventInfo | undefined): void;
+    pushConsentEvent(action: string, body: Record<string, any>): void;
     pushImaAdEvent(action: ImaAdAction, body: Partial<ImaAdEvent>, label?: string | undefined, referrer?: ReferringEventInfo | undefined): void;
     pushInteractionEvent(action: InteractionAction, body: Partial<InteractionEvent>, label?: string | undefined, referrer?: ReferringEventInfo | undefined): void;
     pushWidgetEvent(action: WidgetAction, body: Partial<WidgetEvent>, label?: string | undefined, referrer?: ReferringEventInfo | undefined): void;
@@ -1781,6 +1780,7 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     private _layoutDirection;
     private _shouldAllowClosedCaptions;
     private _appContext;
+    private _disableAutoLoadingContent;
     protected constructor();
     init(options: IBlazeSDKOptions): Promise<void>;
     private _urls;
@@ -1826,6 +1826,8 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     get shouldAllowClosedCaptions(): boolean;
     get appContext(): Record<string, any>;
     set appContext(value: Record<string, any>);
+    get disableAutoLoadingContent(): boolean;
+    set disableAutoLoadingContent(value: boolean);
 }
 export declare const ConfigService: ConfigServiceClass;
 
@@ -2008,7 +2010,7 @@ declare abstract class MomentServiceClass extends MomentServiceClass_base implem
     init(): void;
     fetchContent(dataSource: BlazeDataSourceType): Promise<MomentsResponse>;
     updateMomentReadStatusById(momentId: string): Promise<any>;
-    encrichMoment(moment: IMoment[]): Promise<IMoment[]>;
+    enrichContent(moment: IMoment[]): Promise<IMoment[]>;
 }
 export declare const MomentService: MomentServiceClass;
 
@@ -2030,7 +2032,7 @@ declare const StoryServiceClass_base: {
 declare abstract class StoryServiceClass extends StoryServiceClass_base implements IService {
     init(): void;
     fetchContent(dataSource: BlazeDataSourceType): Promise<StoriesResponse>;
-    enrichStories(stories: IStory[]): Promise<IStory[]>;
+    enrichContent(stories: IStory[]): Promise<IStory[]>;
 }
 export declare const StoryService: StoryServiceClass;
 
@@ -2148,7 +2150,7 @@ declare abstract class VideoServiceClass extends VideoServiceClass_base implemen
     init(): Promise<void>;
     private loadHlsScript;
     fetchContent(dataSource: BlazeDataSourceType): Promise<VideosResponse>;
-    enrichVideos(videos: IVideo[]): Promise<IVideo[]>;
+    enrichContent(videos: IVideo[]): Promise<IVideo[]>;
     getVideoDataById(videoId: string): Promise<VideoDBData | null>;
     updateVideoDataById(videoId: string, data: Partial<VideoDBData>): Promise<void>;
     markVideoAsViewed(videoId: string, poster: string): Promise<void>;
@@ -2165,6 +2167,107 @@ declare abstract class WidgetsServiceClass extends WidgetsServiceClass_base impl
 }
 export declare const WidgetsService: WidgetsServiceClass;
 
+export * from './player.template';
+
+export declare class PlayerViewTemplate {
+    private static templates;
+    static display(type: ContentType, dataSource: BlazeDataSourceType, options: {
+        style: StoryPlayerStyle | VideoPlayerStyle | MomentPlayerStyle;
+        actionHandlers?: ActionHandler[];
+    }): Promise<void>;
+    private static validateStyleType;
+}
+
+export interface ContentResponse<T> {
+    result: T[];
+    defaultAdsInfo?: IAdInfo;
+}
+
+export interface ContentService<T extends IContent> {
+    fetchContent(dataSource: BlazeDataSourceType): Promise<ContentResponse<T>>;
+    enrichContent?(content: T[]): Promise<T[]>;
+}
+
+export * from './modal-options';
+export * from './content-service';
+export * from './content-response';
+
+export interface ModalTemplateOptions<T> {
+    style: T;
+    actionHandlers?: ActionHandler[];
+}
+
+export interface ModalTemplateOptions<T> {
+    actionHandlers?: ActionHandler[];
+}
+export interface ContentResponse<T> {
+    defaultAdsInfo?: IAdInfo;
+}
+export declare abstract class BaseModalTemplate<M extends BlazeWidgetModal, C extends IContent, S> {
+    render(dataSource: BlazeDataSourceType, options: ModalTemplateOptions<S>): Promise<void>;
+    protected validateRequirements(dataSource: BlazeDataSourceType): {
+        isValid: boolean;
+        blazeSdk: null;
+        dataSourceStringRep: undefined;
+    } | {
+        isValid: boolean;
+        blazeSdk: BlazeWidgetSDK;
+        dataSourceStringRep: undefined;
+    } | {
+        isValid: boolean;
+        blazeSdk: BlazeWidgetSDK;
+        dataSourceStringRep: string;
+    };
+    protected filterContent(content: C[]): C[];
+    protected validateContentResponse(data: ContentResponse<C>, blazeSdk: BlazeWidgetSDK, dataSourceStringRep: string): boolean;
+    protected openModal(modal: M, blazeSdk: BlazeWidgetSDK): void;
+    protected handleError(error: unknown, blazeSdk: BlazeWidgetSDK, dataSourceStringRep: string): void;
+    protected fetchContent(dataSource: BlazeDataSourceType): Promise<ContentResponse<C>>;
+    protected abstract createModal(parent: HTMLElement, style: S, actionHandlers?: ActionHandler[]): M;
+    protected abstract prepareContent(content: C[], service: ContentService<C>): Promise<C[]>;
+    protected abstract configureModal(modal: M, content: C[]): void;
+    protected abstract getService(): ContentService<C>;
+    protected abstract getErrorCode(): ErrorCode;
+}
+
+export * from './base.template';
+export * from './story.template';
+export * from './video.template';
+export * from './moment.template';
+
+export declare class MomentModalTemplate extends BaseModalTemplate<BlazeWidgetMomentModal, IMoment, MomentPlayerStyle> {
+    protected createModal(parent: HTMLElement, style: MomentPlayerStyle, actionHandlers?: ActionHandler[]): BlazeWidgetMomentModal;
+    protected prepareContent(content: IMoment[], service: ContentService<IMoment>): Promise<IMoment[]>;
+    protected configureModal(modal: BlazeWidgetMomentModal, content: IMoment[]): void;
+    protected getService(): ContentService<IMoment>;
+    protected getErrorCode(): ErrorCode;
+}
+
+export declare class StoryModalTemplate extends BaseModalTemplate<BlazeWidgetStoryModal, IStory, StoryPlayerStyle> {
+    protected createModal(parent: HTMLElement, style: StoryPlayerStyle, actionHandlers?: ActionHandler[]): BlazeWidgetStoryModal;
+    protected prepareContent(content: IStory[], service: ContentService<IStory>): Promise<IStory[]>;
+    protected configureModal(modal: BlazeWidgetStoryModal, content: IStory[]): void;
+    protected getService(): ContentService<IStory>;
+    protected getErrorCode(): ErrorCode;
+}
+
+export declare class VideoModalTemplate extends BaseModalTemplate<BlazeWidgetVideoModal, IVideo, VideoPlayerStyle> {
+    protected createModal(parent: HTMLElement, style: VideoPlayerStyle): BlazeWidgetVideoModal;
+    protected prepareContent(content: IVideo[], service: ContentService<IVideo>): Promise<IVideo[]>;
+    protected configureModal(modal: BlazeWidgetVideoModal, content: IVideo[]): void;
+    protected getService(): ContentService<IVideo>;
+    protected getErrorCode(): ErrorCode;
+}
+
+export declare function getDataSourceStringRep(dataSource: BlazeDataSourceType): string | undefined;
+
+export * from './data-source.utils';
+export * from './sort.utils';
+
+export declare function sortVideosByViewedStatus(a: IVideo, b: IVideo): number;
+export declare function sortStoriesByViewedStatus(a: IStory, b: IStory): number;
+export declare function sortMomentsByViewedStatus(a: IMoment, b: IMoment): number;
+
 export * from './preset';
 export * from './theme';
 export * from './theme.interface';
@@ -3508,8 +3611,6 @@ export declare class BlazeWidgetVideoModal extends BlazeWidgetModal {
     parentWidget: HTMLElement;
     playerLayout: VideoPlayerStyle;
     data: IVideo[];
-    onClose: (() => void) | undefined;
-    onOpen: (() => void) | undefined;
     boundOnResizeEventDelay: (this: Window, ev: UIEvent) => void;
     boundOnKeyDown: (ev: KeyboardEvent) => void;
     boundOnBeforeUnload: () => void;
@@ -4169,6 +4270,8 @@ export declare class BlazeWidgetModal extends BaseWidget {
     boundOnResizeEvent: (this: Window, ev: UIEvent) => void;
     boundOnPopStateEvent: (ev: PopStateEvent) => void;
     onContentChange?: (mode: ContentDirection) => void;
+    onClose: ((options?: ISmoothOpenCloseModal) => void) | undefined;
+    onOpen: (() => void) | undefined;
     constructor(type: ContentType);
     connectedCallback(): void;
     disconnectedCallback(): void;
@@ -4300,6 +4403,7 @@ export declare class BlazeWidgetSDK extends BaseWidget {
     private injectFontResource;
     private injectGoogleTag;
     private injectIma;
+    private pushInitEvent;
 }
 
 export interface IShareButton {
@@ -4387,7 +4491,6 @@ export declare class BlazeWidgetVideo extends BlazeWidgetVideoBase {
     adDisplayContainer: any;
     adsManager: any;
     shouldShowImaAd: boolean;
-    googleIMA: any;
     isCurrentlyTryingToRunImaAd: boolean;
     hasPoster: boolean;
     static get observedAttributes(): string[];
@@ -4396,6 +4499,7 @@ export declare class BlazeWidgetVideo extends BlazeWidgetVideoBase {
     connectedCallback(): void;
     disconnectedCallback(): void;
     setData(data: IPage): void;
+    getGoogleIMA(): any;
     private isEnableInteractions;
     loadClosedCaptions(): Promise<void>;
     getVideoDuration(existingVideo?: HTMLVideoElement): Promise<number>;
@@ -4450,7 +4554,6 @@ export declare class BlazeWidgetAd extends BlazeWidgetVideoBase {
     private isCurrentlyDisplay;
     private adContainer;
     private placeholderContainer;
-    private googletag;
     private failToLoadTimeout?;
     private onFail?;
     private isAdFailed;
@@ -4467,6 +4570,7 @@ export declare class BlazeWidgetAd extends BlazeWidgetVideoBase {
     get duration(): number;
     get progress(): number;
     set muted(isMuted: boolean);
+    getGoogletag(): any;
     getAdIframeRef(): HTMLIFrameElement | null;
     changeAdMutedState(isMuted: boolean): void;
     setData(data: IPage): void;
@@ -4540,8 +4644,6 @@ export declare class BlazeWidgetMomentModal extends BlazeWidgetModal {
     navigationButtonsContainerElement: BlazeDiv;
     nextContentButtonElement?: BlazeButton;
     prevContentButtonElement?: BlazeButton;
-    onClose: (() => void) | undefined;
-    onOpen: (() => void) | undefined;
     boundOnKeyDown: (ev: KeyboardEvent) => void;
     boundOnNavigationChange: (ev: Event) => void;
     boundOnResizeEventDelay: (this: Window, ev: UIEvent) => void;
@@ -4804,8 +4906,6 @@ export declare class BlazeWidgetStoryModal extends BlazeWidgetModal {
     parentWidget: HTMLElement;
     playerLayout: StoryPlayerStyle;
     actionHandlers?: ActionHandler[] | undefined;
-    onOpen?: () => void;
-    onClose?: (options?: ISmoothOpenCloseModal) => void;
     boundOnResizeEventDelay: (this: Window, ev: UIEvent) => void;
     boundOnKeyDown: (ev: KeyboardEvent) => void;
     boundOnBeforeUnload: () => void;