@wscsports/blaze-web-sdk 0.18.0 → 0.19.0

package/package.json

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

package/publish/index.d.ts

@@ -363,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;
@@ -374,6 +374,7 @@ export interface BlazeDataSourceType {
     maxItems?: number;
     advancedOrdering?: AdvancedOrdering;
     personalized?: BlazePersonalized;
+    recommendations?: BlazeRecommendations;
 }
 export declare const BlazeInternalError: {
     LabelExpressionMustNotBeEmpty: string;
@@ -381,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 {
@@ -393,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): {
@@ -1336,6 +1342,7 @@ export interface AppConfiguration {
         configRefetchIntervalInMinutes?: number;
         enableClientPlaybackModification?: 'true' | 'false' | string;
     };
+    recommendationsConfigurations?: IRecommendationsConfigurations;
     sdkLoggerConfigurations?: ILoggerConfiguration;
 }
 
@@ -2001,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>;
@@ -2120,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 {
@@ -2220,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;
@@ -2365,6 +2382,9 @@ type GetByLabelsOptions = GetOptions & {
 type GetByIdsOptions = GetOptions & {
     ids: string[];
 };
+type GetByRecommendationsOptions = GetOptions & {
+    recommendations: BlazeRecommendations;
+};
 export interface ApiResponse<T> {
     assetsExpiryTime: string;
     totalItems: number;
@@ -2407,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;
@@ -2439,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;
 
@@ -3860,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<{
@@ -3911,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;
@@ -4902,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;
@@ -5346,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;