@wscsports/blaze-web-sdk 0.4.1 → 0.4.3

package/package.json

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

package/publish/index.d.ts

@@ -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;
@@ -337,6 +343,7 @@ export declare abstract class BaseWidget extends HTMLElement {
 }
 
 type BlazeSourceType = 'labels' | 'ids';
+export type AdvancedOrdering = 'LiveFirst';
 export interface BlazeDataSourceType {
     type: BlazeSourceType;
     labels?: string | string[] | BlazeWidgetLabel;
@@ -344,6 +351,7 @@ export interface BlazeDataSourceType {
     ids?: string[];
     orderType?: OrderType;
     maxItems?: number;
+    advancedOrdering?: AdvancedOrdering;
 }
 export declare const BlazeInternalError: {
     LabelExpressionMustNotBeEmpty: string;
@@ -655,7 +663,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" | "disabled" | "blaze-btn-hidden" | "blaze-btn-visible" | "button-desktop-animation")[];
     private onMouseEnter;
     private onMouseLeave;
     private onClick;
@@ -823,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",
@@ -1004,7 +1013,7 @@ export type InteractionType = 'Poll' | 'Quiz' | 'Enrichment';
 type InteractionRelative = 'Player' | 'Screen';
 export type InteractionObjectYPosition = 'BottomToTop' | 'TopToTop' | 'BottomToBottom' | 'TopToBottom' | 'CenterToTop' | 'CenterToBottom' | 'CenterY';
 export type InteractionObjectXPosition = 'StartToStart' | 'EndToEnd' | 'StartToEnd' | 'EndToStart' | 'CenterToStart' | 'CenterToEnd' | 'CenterX';
-type PositionType = {
+type InteractionPositionType = {
     xOffset?: number;
     xPosition?: InteractionObjectXPosition;
     xRelativeTo?: InteractionRelative;
@@ -1012,15 +1021,15 @@ type PositionType = {
     yPosition?: InteractionObjectYPosition;
     yRelativeTo?: InteractionRelative;
 };
-type SizeType = {
+type InteractionSizeType = {
     absoluteHeight?: number;
     absoluteWidth?: number;
     heightRatio?: number;
     widthRatio?: number;
 };
 export type InteractionBounds = {
-    position?: PositionType;
-    size?: SizeType;
+    position?: InteractionPositionType;
+    size?: InteractionSizeType;
 };
 export type Interaction = {
     id: string;
@@ -1409,6 +1418,7 @@ export interface IBlazeSDKOptions {
     autoAdvanceUrl?: string;
     layoutDirection?: LocaleDirectionType;
     shouldAllowClosedCaptions?: boolean;
+    disableAutoLoadingContent?: boolean;
 }
 
 export interface IButtonPlayerNavigationConfig {
@@ -1429,16 +1439,8 @@ export interface IDataSourceBuilder {
     labels: (params: LabelsDataSourceParams) => BlazeDataSourceType;
     ids: (params: IdsDataSourceParams) => BlazeDataSourceType;
 }
-export interface LabelsDataSourceParams {
-    labels: string | string[] | BlazeWidgetLabel;
-    labelsPriority?: string | string[] | BlazeWidgetLabel[];
-    orderType?: OrderType;
-    maxItems?: number;
-}
-export interface IdsDataSourceParams {
-    ids: string[];
-    orderType?: OrderType;
-}
+export type LabelsDataSourceParams = Omit<BlazeDataSourceType, 'type' | 'ids'>;
+export type IdsDataSourceParams = Omit<BlazeDataSourceType, 'type' | 'labels' | 'labelsPriority' | 'maxItems'>;
 
 export interface IDatabase {
     init: () => Promise<void>;
@@ -1653,6 +1655,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;
@@ -1678,13 +1681,23 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
     api: API;
     init(): Promise<void>;
     private setAdsOnStories;
-    getStoriesByIds(storyIds: string[], orderType?: OrderType): Promise<{
+    getStoriesByIds(options: {
+        storyIds: string[];
+        orderType?: OrderType;
+        showLiveFirst?: boolean;
+    }): Promise<{
         result: IStory[];
         httpStatus?: number | undefined;
         data?: StoriesResponse | undefined;
         error?: Error | undefined;
     }>;
-    getStoriesByLabels(labels: string, orderType?: OrderType, maxItems?: number, labelsPriority?: string): Promise<{
+    getStoriesByLabels(options: {
+        labels: string;
+        orderType?: OrderType;
+        maxItems?: number;
+        labelsPriority?: string;
+        showLiveFirst?: boolean;
+    }): Promise<{
         result: IStory[];
         httpStatus?: number | undefined;
         data?: StoriesResponse | undefined;
@@ -1777,6 +1790,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;
@@ -1822,6 +1836,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;
 
@@ -3084,11 +3100,7 @@ export declare function flattenObject<T extends Record<string, any>>(obj: T): Re
 export declare function mergeStyles(element: HTMLElement, styles: Partial<CSSStyleDeclaration>): object;
 export declare function getMaxValue(currentMax: string, newValue: string): string;
 export declare function isReadByLastUnIgnoredPageStatus(story: IStory): boolean;
-export declare function sortByHasViewed(a: {
-    hasViewed: boolean;
-}, b: {
-    hasViewed: boolean;
-}): number;
+export declare const getContentScore: (content: IContent) => 1 | 2;
 export declare function applyPlayerStyleChanges(defaultPlayerStyle: StoryPlayerStyle, mergedPlayerStyle: StoryPlayerStyle, themePlayerStyle: StoryPlayerStyle, playerStyleChanges: any): void;
 export declare function getChangedProperties(source: any, target: any, level: string, playerStyleChanges: any, parentKeys?: string): void;
 export declare function removeDuplicates(source: string[], checkAgainst: string[]): string[];
@@ -4066,6 +4078,7 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
     constructor();
     connectedCallback(): void;
     disconnectedCallback(): void;
+    private getContentType;
     onResizeEventDelay(): void;
     onResize(): void;
     handleHeightChangeMutation(mutationsList: MutationRecord[]): void;
@@ -4147,6 +4160,7 @@ export declare class BlazeWidgetLayout extends BlazeWidgetScrollable implements
         labelAdditionalHeight: number;
     };
     event(action: WidgetAction, data: Partial<WidgetEvent>, label?: string | undefined): void;
+    private sortContent;
     private reorderWidgets;
     updateWidgetsData(): void;
     private updateWidgetDisplay;
@@ -4298,6 +4312,7 @@ export declare class BlazeWidgetSDK extends BaseWidget {
     private injectFontResource;
     private injectGoogleTag;
     private injectIma;
+    private pushInitEvent;
 }
 
 export interface IShareButton {
@@ -4385,7 +4400,6 @@ export declare class BlazeWidgetVideo extends BlazeWidgetVideoBase {
     adDisplayContainer: any;
     adsManager: any;
     shouldShowImaAd: boolean;
-    googleIMA: any;
     isCurrentlyTryingToRunImaAd: boolean;
     hasPoster: boolean;
     static get observedAttributes(): string[];
@@ -4394,6 +4408,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>;
@@ -4448,7 +4463,6 @@ export declare class BlazeWidgetAd extends BlazeWidgetVideoBase {
     private isCurrentlyDisplay;
     private adContainer;
     private placeholderContainer;
-    private googletag;
     private failToLoadTimeout?;
     private onFail?;
     private isAdFailed;
@@ -4465,6 +4479,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;