@wscsports/blaze-web-sdk 0.5.0 → 0.7.0

package/package.json

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

package/publish/index.d.ts

@@ -2,6 +2,7 @@ type PlayContentOptions = {
     dataSource: BlazeDataSourceType;
     actionHandlers?: ActionHandler[];
     style?: StoryPlayerStyle | VideoPlayerStyle | MomentPlayerStyle;
+    shouldOrderContentByReadStatus?: boolean;
 };
 export declare function setDoNotTrack(value: boolean): void;
 export declare function setGeoLocation(value: string): void;
@@ -147,6 +148,7 @@ export declare class ReferringEventInfo {
     'story_source': string;
 }
 export declare class AnalyticsEvent {
+    'sdk_event_session_counter': number;
     'sdk_event_id': string;
     'timestamp_utc': string;
     'timestamp_user_tz': string;
@@ -207,6 +209,8 @@ export declare class StoryEvent {
     'custom_action_button_name': string;
     'enrichment_layer_id': string;
     'enrichment_layer_url': string;
+    'story_page_parent_id': string;
+    'story_composition_type': string;
 }
 export declare class MomentEvent {
     'moments_session_id': string;
@@ -330,6 +334,7 @@ export declare class InteractionEvent {
     'playback_action_method': string;
     'audio_state': string;
     'content_extra_info': string;
+    'client_enrichment_url': string;
 }
 export declare class ConsentEvent {
 }
@@ -353,6 +358,7 @@ export interface BlazeDataSourceType {
     orderType?: OrderType;
     maxItems?: number;
     advancedOrdering?: AdvancedOrdering;
+    personalized?: BlazePersonalized;
 }
 export declare const BlazeInternalError: {
     LabelExpressionMustNotBeEmpty: string;
@@ -664,7 +670,7 @@ export declare class BlazeButton extends BaseWidget {
     isAnimationOnDesktopInitialized: boolean;
     get refElement(): ShadowRoot | this;
     constructor();
-    static get observedAttributes(): ("height" | "order" | "width" | "icon-color" | "disabled" | "blaze-btn-visible" | "blaze-btn-hidden" | "button-desktop-animation")[];
+    static get observedAttributes(): ("height" | "order" | "width" | "icon-color" | "blaze-btn-visible" | "disabled" | "blaze-btn-hidden" | "button-desktop-animation")[];
     private onMouseEnter;
     private onMouseLeave;
     private onClick;
@@ -897,6 +903,12 @@ export declare const CountryCodes: readonly ["AF", "AX", "AL", "DZ", "AS", "AD",
 
 export declare const DEFAULT_CTA_HEIGHT = 40;
 export declare const MIN_PADDING_BOTTOM = 10;
+export declare const Z_INDEX: {
+    readonly base: "0";
+    readonly player: "1";
+    readonly interaction: "2";
+    readonly onTopOfPlayer: "3";
+};
 
 export declare const ONE_SECOND = 1000;
 export declare const ONE_AND_HALF_SECOND = 1500;
@@ -1043,6 +1055,7 @@ export type Interaction = {
     initData: string;
     designOverridesStr: string;
     bounds?: InteractionBounds;
+    clientEnrichmentUrl?: string;
 };
 export type InteractionDB = Pick<Interaction, 'id' | 'initData'> & {
     userResponse?: string;
@@ -1065,7 +1078,33 @@ export type InteractionIframeVibrate = {
         type: keyof typeof ANSWER_FEEDBACK_VIBRATE_PATTERNS;
     };
 };
-export type InteractionIframeCustomEvent = InteractionIframeResponse | InteractionIframeVibrate;
+export type EnrichmentIframeTriggerHaptic = {
+    type: 'hapticFeedback';
+    data: {
+        type: keyof typeof ANSWER_FEEDBACK_VIBRATE_PATTERNS;
+    };
+};
+export type EnrichmentIframePlay = {
+    type: 'play';
+    data: undefined;
+};
+export type EnrichmentIframePause = {
+    type: 'pause';
+    data: undefined;
+};
+export type EnrichmentIframeNextPage = {
+    type: 'goToNextPage';
+    data: undefined;
+};
+export type EnrichmentIframePreviousPage = {
+    type: 'goToPreviousPage';
+    data: undefined;
+};
+export type EnrichmentIframeSetAppContext = {
+    type: 'setAppContext';
+    data: Record<string, any>;
+};
+export type InteractionIframeCustomEvent = InteractionIframeResponse | InteractionIframeVibrate | EnrichmentIframePlay | EnrichmentIframePause | EnrichmentIframePreviousPage | EnrichmentIframeNextPage | EnrichmentIframeSetAppContext | EnrichmentIframeTriggerHaptic;
 export declare const INTERACTION_ANALYTICS = "INTERACTION_ANALYTICS";
 
 export interface ILayerContent {
@@ -1114,6 +1153,7 @@ export interface IContentPage extends IBasePage {
     thumbnail: IThumbnail;
     baseLayer: ILayer;
     cta: ICta;
+    parentStoryId?: string;
     shouldShowImaAd?: boolean;
     adInfo?: IAdInfo;
     interaction?: Interaction;
@@ -1138,6 +1178,7 @@ export interface IStory extends IContent {
     isLive: boolean;
     pages: IPage[];
     adInfo?: IAdInfo;
+    compositionType?: string;
 }
 
 export interface IThumbnail {
@@ -1218,7 +1259,11 @@ export declare enum InternalEvent {
     AD_ENDED = "ad_ended",
     AD_RESUMED = "ad_resumed",
     AD_STARTED = "ad_started",
-    BANNER_ANALYTICS = "banner_analytics"
+    BANNER_ANALYTICS = "banner_analytics",
+    PAUSE = "pause",
+    RESUME = "resume",
+    NEXT_PAGE = "next_page",
+    PREVIOUS_PAGE = "previous_page"
 }
 export interface InternalEventDetails {
     [InternalEvent.BANNER_ANALYTICS]: {
@@ -1607,6 +1652,7 @@ export interface IWidgetView extends HTMLElement {
     updateOverrideStyles: (perItemStyleOverrides: PerItemStyleOverrides) => void;
     setId: (id: string) => void;
     updateDataSource: (dataSource: BlazeDataSourceType) => void;
+    setPersonalized: (personalized: BlazePersonalized) => void;
     setLabels: (labels: string | string[] | BlazeWidgetLabel, options?: ISetWidgetOptions) => void;
     setLabelsPriority: (labelsPriority: string | string[] | BlazeWidgetLabel[], options?: ISetWidgetOptions) => void;
     setContentIds: (storyIds: string[], options?: ISetWidgetOptions) => void;
@@ -1640,6 +1686,7 @@ declare const AnalyticsServiceClass_base: {
 declare abstract class AnalyticsServiceClass extends AnalyticsServiceClass_base implements IService {
     events: AnalyticsEvent[];
     uaParsed?: IDevice;
+    eventSessionCounter: number;
     init(): Promise<void>;
     sendAnalyticsData(): Promise<void>;
     bulkEvent(body: Partial<AnalyticsEvent>[]): Promise<any>;
@@ -1677,6 +1724,7 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
         storyIds: string[];
         orderType?: OrderType;
         showLiveFirst?: boolean;
+        personalized?: BlazePersonalized;
     }): Promise<{
         result: IStory[];
         httpStatus?: number | undefined;
@@ -1689,6 +1737,7 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
         maxItems?: number;
         labelsPriority?: string;
         showLiveFirst?: boolean;
+        personalized?: BlazePersonalized;
     }): Promise<{
         result: IStory[];
         httpStatus?: number | undefined;
@@ -2179,6 +2228,7 @@ export declare class PlayerViewTemplate {
     static display(type: ContentType, dataSource: BlazeDataSourceType, options: {
         style: StoryPlayerStyle | VideoPlayerStyle | MomentPlayerStyle;
         actionHandlers?: ActionHandler[];
+        orderByReadStatus: boolean;
     }): Promise<void>;
     private static validateStyleType;
 }
@@ -2209,7 +2259,7 @@ 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>;
+    render(dataSource: BlazeDataSourceType, options: ModalTemplateOptions<S>, orderByReadStatus: boolean): Promise<void>;
     protected validateRequirements(dataSource: BlazeDataSourceType): {
         isValid: boolean;
         blazeSdk: null;
@@ -2229,7 +2279,6 @@ export declare abstract class BaseModalTemplate<M extends BlazeWidgetModal, C ex
     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;
@@ -2242,7 +2291,6 @@ 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;
@@ -2250,7 +2298,6 @@ export declare class MomentModalTemplate extends BaseModalTemplate<BlazeWidgetMo
 
 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;
@@ -2258,7 +2305,6 @@ export declare class StoryModalTemplate extends BaseModalTemplate<BlazeWidgetSto
 
 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;
@@ -2269,9 +2315,7 @@ export declare function getDataSourceStringRep(dataSource: BlazeDataSourceType):
 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 declare function sortContentByViewedStatus<T extends IContent>(a: T, b: T): number;
 
 export * from './preset';
 export * from './theme';
@@ -3030,7 +3074,7 @@ export type ComponentsElementType = 'blaze-alert' | 'blaze-chip' | 'blaze-image'
 export type WidgetElementType = 'blaze-sdk';
 export type ElementType = WidgetElementType | ComponentsElementType;
 
-export type EnvironmentType = 'prod' | 'uat';
+export type EnvironmentType = 'prod' | 'uat' | 'local';
 
 export type StoryGestureType = 'Swipe Up' | 'CTA Click';
 export type MomentGestureType = 'CTA Click';
@@ -3051,6 +3095,7 @@ export * from './item.type';
 export * from './label.type';
 export * from './locale.type';
 export * from './order.type';
+export * from './personalized.type';
 export * from './platform.type';
 export * from './play.type';
 export * from './player-layout.type';
@@ -3087,6 +3132,18 @@ export type LocaleDirectionType = 'LTR' | 'RTL';
 export type OrderType = 'Manual' | 'AtoZ' | 'ZtoA' | 'RecentlyUpdatedFirst' | 'RecentlyUpdatedLast' | 'RecentlyCreatedFirst' | 'RecentlyCreatedLast';
 export type ContentOrderType = 'LIVE_CHIP' | 'STORY_TITLE' | 'PUBLISHED_DATE';
 
+type BlazePersonalizedIds = {
+    type: 'ids';
+    teams?: Array<string>;
+    players?: Array<string>;
+};
+type BlazePersonalizedLabels = {
+    type: 'labels';
+    labelsFilterExpression: string | string[] | BlazeWidgetLabel;
+    labelsPriority: string | string[] | BlazeWidgetLabel[];
+};
+export type BlazePersonalized = BlazePersonalizedIds | BlazePersonalizedLabels;
+
 export type Platform = 'mobile' | 'tablet' | 'desktop';
 
 export declare const PlayTypeArray: readonly ["Widget", "Share", "SingleContent", "AutoAdvance"];
@@ -3172,6 +3229,7 @@ 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 isStory(content: IContent): content is IStory;
 
 export declare function formatDuration(startDate: Date): string;
 export declare function isCssPropertySupported(property: string): boolean;
@@ -3209,11 +3267,29 @@ export * from './common.utils';
 export * from './country-location.utils';
 export * from './guard.utils';
 export * from './helper';
+export * from './personalized.utils';
 export * from './regex.utils';
 export * from './stopwatch';
 export * from './position.utils';
 export * from './ad-info.utils';
 
+export declare function getPersonalizedParamsForRequest(personalized?: BlazePersonalized): {
+    PersonalPlayers?: undefined;
+    PersonalTeams?: undefined;
+    PersonalLabelFilterExpression?: undefined;
+    PersonalLabelPriority?: undefined;
+} | {
+    PersonalPlayers: string[] | undefined;
+    PersonalTeams: string[] | undefined;
+    PersonalLabelFilterExpression?: undefined;
+    PersonalLabelPriority?: undefined;
+} | {
+    PersonalLabelFilterExpression: string | string[] | import("../classes").BlazeWidgetLabel;
+    PersonalLabelPriority: string | string[] | import("../classes").BlazeWidgetLabel[];
+    PersonalPlayers?: undefined;
+    PersonalTeams?: undefined;
+};
+
 export declare function calculatePosition(statusIndicatorPosition: PositionType): {
     isOutside: boolean;
     isInside: boolean;
@@ -3587,7 +3663,7 @@ export declare class BlazeVideoNavigationOverlay extends HTMLElement {
     loader: BlazeLoader;
     private _platform;
     constructor();
-    static get observedAttributes(): ("hidden" | "layout" | "has-next" | "has-prev")[];
+    static get observedAttributes(): ("layout" | "hidden" | "has-next" | "has-prev")[];
     attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
     private applyAttribute;
     connectedCallback(): void;
@@ -4017,6 +4093,7 @@ export declare class BlazeWidgetEmbeddedStory extends BaseWidget implements IWid
     bindedOnPlayerDismissed: (e: Event) => void;
     private get theme();
     constructor();
+    setPersonalized(personalized: BlazePersonalized): void;
     static get observedAttributes(): string[];
     connectedCallback(): void;
     disconnectedCallback(): void;
@@ -4063,6 +4140,8 @@ export declare class BlazeWidgetEmbeddedStory extends BaseWidget implements IWid
 export declare class BlazeWidgetInteraction extends BaseWidget {
     private iframe;
     private interaction?;
+    private isIframeLoaded;
+    private isInitialized;
     private isActive;
     private shouldForceHide;
     private responseHandler;
@@ -4167,6 +4246,7 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     onResizeEvent: (this: Window, ev: UIEvent) => void;
     shouldReloadWhenPlayerIsClosed: boolean;
     shouldReloadData: boolean;
+    private personalized?;
     get refElement(): ShadowRoot | BlazeWidgetLayout;
     constructor();
     connectedCallback(): void;
@@ -4261,6 +4341,7 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     connectWidgets(): void;
     get thumbnailShape(): ThumbnailShape;
     widgetType(): WidgetType;
+    setPersonalized(personalized?: BlazePersonalized): void;
 }
 
 export declare class BlazeWidgetModal extends BaseWidget {
@@ -5032,6 +5113,10 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     requestAnimationId: number | null;
     shouldShowImaAdOnStart: boolean;
     bannerAdElement?: BlazeWidgetBannerAd;
+    boundOnResumeEvent: () => void;
+    boundOnPauseEvent: () => void;
+    boundOnNextPageEvent: () => void;
+    boundOnPrevPageEvent: () => void;
     get currentPageIndexWithoutCustomAds(): number;
     constructor(playerStyle: StoryPlayerStyle, mode: ScreenMode, actionHandlers?: ActionHandler[]);
     isButtonVisible(iconName: IconButtonType | StoryDirectionType): boolean | undefined;
@@ -5083,6 +5168,7 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     bannerAdEvent(detail: InternalEventDetails[InternalEvent.BANNER_ANALYTICS]): void;
     event(action: StoryAction, storyData: Partial<StoryEvent>, label?: string | undefined): Promise<void>;
     updateContainerLayout(): void;
+    private addOrRemoveEventListeners;
     connectedCallback(): void;
     onShareModalClose(): void;
     updateStoryProgress(): void;
@@ -5126,6 +5212,10 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     resetLayout(): void;
     render(): void;
     onExpandClick(): void;
+    private onResumeEvent;
+    private onPauseEvent;
+    private onNextPageEvent;
+    private onPrevPageEvent;
 }
 
 export declare const ElementId: {