@wscsports/blaze-web-sdk 0.17.1 → 0.19.0

package/package.json

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

package/publish/index.d.ts

@@ -32,6 +32,7 @@ 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;
 export declare const isInitialized: () => boolean;
+export declare function setBeforeContentPlayCallback(callback: BeforeContentPlayCallback | undefined): void;
 declare const _default: {
     Initialize: typeof Initialize;
     WidgetGridView: typeof WidgetGridView;
@@ -58,6 +59,7 @@ declare const _default: {
     getAppContextManager: typeof getAppContextManager;
     pushConsentEvent: (action: string, body: Record<string, any>) => void;
     isInitialized: () => boolean;
+    setBeforeContentPlayCallback: typeof setBeforeContentPlayCallback;
 };
 export default _default;
 
@@ -361,7 +363,7 @@ export declare abstract class BaseWidget extends HTMLElement {
     removeElement(): void;
 }
 
-type BlazeSourceType = 'labels' | 'ids';
+type BlazeSourceType = 'labels' | 'ids' | 'recommendations';
 export type AdvancedOrdering = 'LiveFirst';
 export interface BlazeDataSourceType {
     sourceType: BlazeSourceType;
@@ -372,6 +374,7 @@ export interface BlazeDataSourceType {
     maxItems?: number;
     advancedOrdering?: AdvancedOrdering;
     personalized?: BlazePersonalized;
+    recommendations?: BlazeRecommendations;
 }
 export declare const BlazeInternalError: {
     LabelExpressionMustNotBeEmpty: string;
@@ -379,10 +382,15 @@ export declare const BlazeInternalError: {
     IdsMustNotBeEmpty: string;
     MissingLabelsProperty: string;
     IdsMustNotHaveSpaces: string;
+    ForYouNotSupported: string;
+    TrendingNotSupported: string;
+    ForYouContentPreparationNotSupported: string;
+    TrendingContentPreparationNotSupported: string;
 };
 export declare class BlazeDataSourceFactory {
     static createLabelsDataSource(params: LabelsDataSourceParams): BlazeDataSourceType;
     static createIdsDataSource(params: IdsDataSourceParams): BlazeDataSourceType;
+    static createRecommendationsDataSource(params: RecommendationsDataSourceParams): BlazeDataSourceType;
     static setLabelsPriority(labelsPriority: string | string[] | BlazeWidgetLabel[] | undefined): string;
 }
 export declare class BlazeDataSourceValidations {
@@ -391,7 +399,7 @@ export declare class BlazeDataSourceValidations {
         labels?: string | string[] | BlazeWidgetLabel;
         storyIds?: string[];
         contentIds?: string[];
-    }, dataSource?: BlazeDataSourceType): void;
+    }, dataSource?: BlazeDataSourceType, contentType?: ContentType): void;
 }
 
 export declare function debounce<T extends (...args: any[]) => any>(func: T, delay: number): {
@@ -1332,7 +1340,9 @@ export interface AppConfiguration {
     configurations: {
         analyticsAddEntitiesInfo?: string;
         configRefetchIntervalInMinutes?: number;
+        enableClientPlaybackModification?: 'true' | 'false' | string;
     };
+    recommendationsConfigurations?: IRecommendationsConfigurations;
     sdkLoggerConfigurations?: ILoggerConfiguration;
 }
 
@@ -1942,6 +1952,14 @@ export interface ImaAdHandler {
     provideAdExtraParams?: (contentExtraInfo?: ContentExtraInfo) => ImaExtraParams;
 }
 
+export interface BeforeContentPlayContext {
+    originalUrl: string;
+}
+export interface BeforeContentPlayResult {
+    resultUrl: string;
+}
+export type BeforeContentPlayCallback = (context: BeforeContentPlayContext) => Promise<BeforeContentPlayResult> | BeforeContentPlayResult;
+
 export interface ISmoothOpenCloseModal {
     storyId?: string;
     pageIndex: number;
@@ -1990,9 +2008,11 @@ export interface IButtonPlayerConfig {
 export interface IDataSourceBuilder {
     labels: (params: LabelsDataSourceParams) => BlazeDataSourceType;
     ids: (params: IdsDataSourceParams) => BlazeDataSourceType;
+    recommendations: (params: RecommendationsDataSourceParams) => BlazeDataSourceType;
 }
-export type LabelsDataSourceParams = Omit<BlazeDataSourceType, 'sourceType' | 'ids'>;
-export type IdsDataSourceParams = Omit<BlazeDataSourceType, 'sourceType' | 'labels' | 'labelsPriority' | 'maxItems'>;
+export type LabelsDataSourceParams = Omit<BlazeDataSourceType, 'sourceType' | 'ids' | 'recommendations'>;
+export type IdsDataSourceParams = Omit<BlazeDataSourceType, 'sourceType' | 'labels' | 'recommendations' | 'labelsPriority' | 'maxItems'>;
+export type RecommendationsDataSourceParams = Omit<BlazeDataSourceType, 'sourceType' | 'ids' | 'labels'>;
 
 export interface IDatabase {
     init: () => Promise<void>;
@@ -2091,6 +2111,7 @@ export type BlazeVideoIconsStyle = BaseBlazeIcons & {
 
 export * from './accessibility-manager.interface';
 export * from './ad-handler.interface';
+export * from './before-content-play.interface';
 export * from './behaviors.interface';
 export * from './blaze-sdk.interface';
 export * from './button.interface';
@@ -2108,6 +2129,7 @@ export * from './widget-label-builder.interface';
 export * from './widget-options.interface';
 export * from './widget-view.interface';
 export * from './item-click-callback.interface';
+export * from './recommendations.interface';
 export { default as Observable } from './observable';
 
 export interface ItemClickContext {
@@ -2208,6 +2230,13 @@ export default interface IntersectionObservable {
 
 export type ScreenMode = 'Full Screen' | 'Embedded';
 
+export interface IRecommendationsConfigurations {
+    enableForYouContentPreparation: boolean;
+    enableTrendingContentPreparation: boolean;
+    supportForYou: boolean;
+    supportTrending: boolean;
+}
+
 export interface IResponse<T = any> {
     data?: T;
     error?: Error;
@@ -2353,6 +2382,9 @@ type GetByLabelsOptions = GetOptions & {
 type GetByIdsOptions = GetOptions & {
     ids: string[];
 };
+type GetByRecommendationsOptions = GetOptions & {
+    recommendations: BlazeRecommendations;
+};
 export interface ApiResponse<T> {
     assetsExpiryTime: string;
     totalItems: number;
@@ -2395,6 +2427,7 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
         error?: Error | undefined;
     }>;
     getMomentsByLabels(options: GetByLabelsOptions): Promise<import("../interfaces").IHttpResponse<MomentsResponse>>;
+    getMomentsByRecommendations(options: GetByRecommendationsOptions): Promise<import("../interfaces").IHttpResponse<MomentsResponse>>;
     updateMomentLikeStatus(options: {
         momentId: string;
         setLiked: boolean;
@@ -2427,6 +2460,7 @@ declare abstract class ApiServiceClass extends ApiServiceClass_base implements I
     private getContentDefaultParams;
     private getContentParamsByLabels;
     private getContentParamsByIds;
+    private getContentParamsByRecommendations;
 }
 export declare const ApiService: ApiServiceClass;
 
@@ -2447,6 +2481,10 @@ declare abstract class AppConfigurationServiceClass extends AppConfigurationServ
 }
 export declare const AppConfigurationService: AppConfigurationServiceClass;
 
+export declare class BeforeContentPlayService {
+    getTokenizedUrl(originalUrl: string): Promise<string>;
+}
+
 declare const ConfigServiceClass_base: {
     new (): {};
     _instance: ConfigServiceClass;
@@ -2484,6 +2522,7 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     private _appContext;
     private _disableAutoLoadingContent;
     private _onItemClick;
+    private _beforeContentPlayCallback?;
     protected constructor();
     init(options: IBlazeSDKOptions): Promise<void>;
     private readonly _russiaRegionCDN;
@@ -2545,6 +2584,8 @@ declare abstract class ConfigServiceClass extends ConfigServiceClass_base implem
     set disableAutoLoadingContent(value: boolean);
     get onItemClick(): ItemClickCallback | undefined;
     set onItemClick(value: ItemClickCallback | undefined);
+    get beforeContentPlayCallback(): BeforeContentPlayCallback | undefined;
+    set beforeContentPlayCallback(callback: BeforeContentPlayCallback | undefined);
 }
 export declare const ConfigService: ConfigServiceClass;
 
@@ -2648,6 +2689,7 @@ export * from './ad.service';
 export * from './analytics.service';
 export * from './api.service';
 export * from './app-configuration.service';
+export * from './before-content-play.service';
 export * from './config.service';
 export * from './database.service';
 export * from './error.service';
@@ -3840,6 +3882,7 @@ export * from './action-handler.type';
 export * from './cc-language.type';
 export * from './widget-view-options.type';
 export * from './content-item.type';
+export * from './recommendations.type';
 
 export type EntitiesType = 'playerId' | 'teamId' | 'gameId' | 'roundId';
 export type PerItemStyleOverrides = Partial<Record<EntitiesType, Array<{
@@ -3891,6 +3934,18 @@ export type PrefetchingPolicyType = 'low' | 'default';
 
 export type ContentAspectRatio = 'Vertical' | 'Horizontal';
 
+type RecommendationsType = {
+    anyLabelFilter?: string[];
+};
+export type BlazeRecommendationsForYou = RecommendationsType & {
+    promotedLabels?: string[];
+};
+export type BlazeRecommendationsTrending = RecommendationsType;
+export type BlazeRecommendations = {
+    forYou?: BlazeRecommendationsForYou;
+    trending?: BlazeRecommendationsTrending;
+};
+
 export type ScreenState = 'default_view' | 'full_screen';
 export type ScreenChangeState = {
     current_state: ScreenState;
@@ -4744,7 +4799,7 @@ export interface PlaybackStrategy {
     toggleFullscreen(): void;
     seek(time: number): void;
     getDuration(): number;
-    loadSource(src: string, bitRate: number, startingTime: number): void;
+    loadSource(src: string, bitRate: number, startingTime: number): Promise<void>;
     unload(): void;
     destroy(): void;
 }
@@ -4757,6 +4812,7 @@ export declare class HLSStrategy implements PlaybackStrategy {
     private retryCount;
     private maxRetries;
     private lastTime;
+    private beforeContentPlayService;
     private playbackWatchdogTimeout?;
     private loaderTimeout?;
     private recoveryTimeout?;
@@ -4771,7 +4827,7 @@ export declare class HLSStrategy implements PlaybackStrategy {
     private boundOnNativeError;
     constructor(video: HTMLVideoElement);
     initialize(videoOverlay: BlazeLongFormControlsOverlay): void;
-    loadSource(src: string, initialBitrate: number, startingTime?: number): void;
+    loadSource(src: string, initialBitrate: number, startingTime?: number): Promise<void>;
     unload(): void;
     destroy(): void;
     private waitForVideoCondition;
@@ -4881,6 +4937,7 @@ export declare abstract class WidgetBaseLayout extends BlazeWidgetScrollable imp
     setContentIds(ids: string[], options?: ISetWidgetOptions): void;
     setMaxItemsSize(maxItemsSize?: number, options?: ISetWidgetOptions): void;
     setActionHandlers(actionHandlers: ActionHandler[]): void;
+    setRecommendations(recommendations?: BlazeRecommendations, options?: ISetWidgetOptions): void;
     protected appendModalToBlazeSDK(modal: BlazeWidgetMomentModal | BlazeWidgetStoryModal | BlazeWidgetVideoModal): void;
     updateWidgetsData(): void;
     protected abstract reorderWidgetItems(): void;
@@ -5325,7 +5382,6 @@ export declare class BlazeWidgetLayout extends WidgetBaseLayout {
     connectWidgets(): void;
     get thumbnailShape(): ThumbnailShape;
     widgetType(): WidgetType;
-    setPersonalized(personalized?: BlazePersonalized): void;
     private setupAccessibility;
     private updateAccessibilityLabel;
     onKeyDown(e: KeyboardEvent): void;
@@ -5576,6 +5632,7 @@ export declare class BlazeWidgetVideo extends BlazeWidgetVideoBase {
     eventRenderBackgroundPercentageTriggered: Array<boolean>;
     loaderTimeoutRefAppending: NodeJS.Timeout | undefined;
     lastErrorExecutionTime: number;
+    private beforeContentPlayService;
     isVideoStartPlaying: boolean;
     isError: boolean;
     isLoaded: boolean;
@@ -5594,6 +5651,7 @@ export declare class BlazeWidgetVideo extends BlazeWidgetVideoBase {
     connectedCallback(): void;
     disconnectedCallback(): void;
     private getContentType;
+    private getOriginalVideoUrl;
     setData(data: IPage): void;
     getGoogleIMA(): any;
     private isEnableInteractions;
@@ -5603,7 +5661,7 @@ export declare class BlazeWidgetVideo extends BlazeWidgetVideoBase {
     display(): void;
     hide(): void;
     load(loadingType?: LoadingType): Promise<void>;
-    setVideoSource(videoUrl: string): void;
+    private setVideoSource;
     unload(): Promise<void>;
     resetVideoState(): void;
     removeLoader(): void;
@@ -5630,6 +5688,7 @@ export declare class BlazeWidgetVideo extends BlazeWidgetVideoBase {
     onLanguageChange(event: Event): Promise<void>;
     handleInteractionEvent(event: CustomEvent<InteractionAnalyticCustomEvent>): void;
     private tryToPlayAd;
+    private updateVideoUrlWithBeforeContentPlay;
 }
 
 export declare class BlazeWidgetAd extends BlazeWidgetVideoBase {
@@ -6215,7 +6274,6 @@ export declare class BlazeWidgetStory extends BlazeWidgetContent {
     switchToPage(newPageIndex: number): void;
     startPage(indexToPlay: number): void;
     unload(): void;
-    removeFromCache(): void;
     displayCurrentStoryPageAndHideTheRest(): void;
     load(loadingType?: LoadingType): void;
     play(): void;