@wscsports/blaze-web-sdk 0.34.2 → 0.35.2

package/{publish/index.d.ts → index.d.ts}

@@ -60,11 +60,17 @@ export interface IndicatorStyle {
 	textSize: string;
 	letterSpacing: string;
 	font: string;
+	fontWeight?: FontWeightType;
 	isVisible: boolean;
 	width?: number;
 	height?: number;
 	padding: string;
 	positionOffset?: PartialPositionOffset;
+	icon?: {
+		url: string;
+		color?: string;
+		size?: string;
+	};
 }
 export interface LayoutStyle {
 	thumbnailShape: ThumbnailShape;
@@ -74,6 +80,7 @@ export interface LayoutStyle {
 	itemRatio: number;
 	isSkeleton: boolean;
 	labelStyle: LabelStyle;
+	startTimeStyle: StartTimeStyle;
 	lines: number;
 	wordBreak: string;
 	horizontalItemsSpacing: number;
@@ -85,9 +92,33 @@ export interface LayoutStyle {
 	statusLiveUnreadStyle: IndicatorStyle;
 	statusReadStyle: IndicatorStyle;
 	statusUnreadStyle: IndicatorStyle;
+	statusUpcomingStyle: IndicatorStyle;
+	statusEndedStyle: IndicatorStyle;
 	statusIndicatorPosition: PositionType;
 	badgeIndicatorStyle: IndicatorStyle;
 	badgePosition: PositionType;
+	playButtonStyle: ThumbnailPlayButtonStyle;
+	durationBadgeStyle: DurationBadgeStyle;
+}
+export type ThumbnailPlayButtonColorMode = "light" | "dark";
+export interface ThumbnailPlayButtonStyle {
+	isVisible: boolean;
+	colorMode: ThumbnailPlayButtonColorMode;
+	iconColor?: string;
+	backgroundColor?: string;
+	size?: string;
+	iconSize?: string;
+}
+export interface DurationBadgeStyle {
+	isVisible: boolean;
+	textColor: string;
+	backgroundColor: string;
+	font: string;
+	fontSize: string;
+	borderRadius: string;
+	padding: string;
+	position: PositionType;
+	positionOffset?: PartialPositionOffset;
 }
 export interface LabelStyle {
 	isVisible: boolean;
@@ -103,12 +134,33 @@ export interface LabelStyle {
 	textAlign?: string;
 	position: PositionType;
 }
+export type TitleImageSourceMode = "dynamic" | "static";
+export type TitleImageConfig = {
+	isVisible: boolean;
+	size: number;
+	sourceMode: TitleImageSourceMode;
+	staticUrl?: string;
+	dynamicFallbackUrl?: string;
+};
+export interface StartTimeStyle {
+	isVisible: boolean;
+	backgroundColor: string;
+	textColor: string;
+	padding: string;
+	borderRadius: string;
+	font: string;
+	fontSize: string;
+	fontWeight: FontWeightType;
+	letterSpacing: string;
+	position: PositionType;
+}
 export interface StoryPlayerStyle {
 	titleVisible: boolean;
 	titleFont: string;
 	titleFontSize: string;
 	titleFontSizeEmbedded: string;
 	titleColor: string;
+	titleImage: TitleImageConfig;
 	publishedDateVisible: boolean;
 	publishedDateFont: string;
 	publishedDateFontSize: string;
@@ -283,7 +335,75 @@ export interface VideoPlayerStyle {
 	cta: BlazeVideosPlayerCtaStyle;
 	seekBar: BlazeVideosPlayerSeekBarStyle;
 	icons: BlazeVideoIconsStyle;
+	/**
+	 * Status indicator shown in player header (LIVE/UPCOMING/ENDED chip)
+	 * Matches Android's BlazeVideosPlayerStatusIndicatorStyle
+	 */
+	statusIndicator: BlazeVideosPlayerStatusIndicatorStyle;
+	/**
+	 * Back-to-live button for live stream playback
+	 * Shows "Live" when at edge, "Back to Live" when behind
+	 * Matches Android's BlazeVideosPlayerBackToLiveButtonStyle
+	 */
+	backToLiveButton: BlazeVideosPlayerBackToLiveButtonStyle;
 }
+/**
+ * Position configuration for status indicator in video player
+ */
+export type BlazeVideosPlayerStatusIndicatorPositionStyle = {
+	top: string;
+	left: string;
+	right: string;
+};
+/**
+ * Container style for status indicator (for inline positioning next to title)
+ */
+export type BlazeVideosPlayerStatusIndicatorContainerStyle = {
+	gap?: string;
+	alignItems?: string;
+	display?: string;
+};
+/**
+ * Status indicator style for video player (LIVE/UPCOMING/ENDED chips)
+ */
+export type BlazeVideosPlayerStatusIndicatorStyle = {
+	isVisible: boolean;
+	padding: string;
+	position: BlazeVideosPlayerStatusIndicatorPositionStyle;
+	containerStyle?: BlazeVideosPlayerStatusIndicatorContainerStyle;
+	streamStates: {
+		upcoming: IndicatorStyle;
+		live: IndicatorStyle;
+		ended: IndicatorStyle;
+	};
+	upcomingDateStyle: IndicatorStyle;
+};
+/**
+ * Single state style for back-to-live button
+ */
+export type BlazeVideosPlayerBackToLiveButtonStateStyle = {
+	text: string;
+	textColor: string;
+	textSize: string;
+	font: string;
+	backgroundColor: string;
+	borderRadius: string;
+	icon?: {
+		url: string;
+		color?: string;
+	};
+};
+/**
+ * Back-to-live button style for live stream playback
+ */
+export type BlazeVideosPlayerBackToLiveButtonStyle = {
+	margins: string;
+	padding: string;
+	playbackStates: {
+		atLiveEdgeState: BlazeVideosPlayerBackToLiveButtonStateStyle;
+		behindLiveState: BlazeVideosPlayerBackToLiveButtonStateStyle;
+	};
+};
 export type BlazeVideosPlayerHeadingTextStyle = {
 	textStyle: BlazeTextStyle;
 	contentSource: "TITLE";
@@ -383,6 +503,99 @@ export interface PositionOffset {
 }
 export type PartialPositionOffset = Partial<PositionOffset>;
 export type IconsPositionType = "HORIZONTAL" | "VERTICAL";
+/**
+ * Type of video content
+ * - Video: On-demand video content
+ * - Stream: Live streaming content
+ */
+export type VideoContentType = "Video" | "Stream";
+/**
+ * Video content filtering options
+ * Use to filter video widget content by content type and stream state
+ *
+ * @example
+ * // Using presets (recommended for common cases)
+ * videoFilters: VideoFilters.liveOnly()      // Only live streams
+ * videoFilters: VideoFilters.watchable()     // Videos + live streams
+ * videoFilters: VideoFilters.vodOnly()       // Only on-demand videos
+ *
+ * @example
+ * // Using custom filters (for advanced cases)
+ * videoFilters: {
+ *   contentTypes: ['Stream'],
+ *   streamStates: ['Live', 'Upcoming']
+ * }
+ */
+export interface IVideoFilterOptions {
+	contentTypes?: VideoContentType[];
+	streamStates?: Exclude<StreamState, null>[];
+}
+/**
+ * Video filter presets for common filtering scenarios
+ *
+ * @example
+ * // Using builder pattern (recommended)
+ * const filters = VideoFilterBuilder();
+ * videoFilters: filters.liveOnly()      // Only live streams
+ * videoFilters: filters.watchable()     // Videos + live streams
+ *
+ * @example
+ * // Using custom filter with validation
+ * const filters = VideoFilterBuilder();
+ * videoFilters: filters.custom({
+ *   contentTypes: ['Stream'],
+ *   streamStates: ['Live', 'Upcoming']
+ * })
+ *
+ * @example
+ * // Using direct object (validation happens in SDK)
+ * videoFilters: {
+ *   contentTypes: ['Stream'],
+ *   streamStates: ['Live', 'Upcoming']
+ * }
+ */
+export declare class VideoFilters {
+	/**
+	 * Only show currently live streams
+	 */
+	static liveOnly(): IVideoFilterOptions;
+	/**
+	 * Only show upcoming scheduled streams
+	 */
+	static upcomingOnly(): IVideoFilterOptions;
+	/**
+	 * Only show ended streams (replays)
+	 */
+	static endedOnly(): IVideoFilterOptions;
+	/**
+	 * Show all streams regardless of state (live, upcoming, ended)
+	 */
+	static allStreams(): IVideoFilterOptions;
+	/**
+	 * Only show on-demand video content (not streams)
+	 */
+	static vodOnly(): IVideoFilterOptions;
+	/**
+	 * Show watchable content: on-demand videos + live streams
+	 * Excludes upcoming streams and ended streams (no replay URLs)
+	 */
+	static watchable(): IVideoFilterOptions;
+	/**
+	 * @internal
+	 * Convert filter options to API query string format
+	 */
+	static toApiFormat(options?: IVideoFilterOptions): {
+		contentTypes?: string;
+		streamStates?: string;
+	};
+	/**
+	 * @internal
+	 * Validate video filter options
+	 * Called automatically by the SDK when filters are used
+	 * @throws Error if filter configuration is invalid
+	 */
+	static validate(options: IVideoFilterOptions): void;
+}
 export type BlazeAbTestType = {
 	id: string;
 	variant: string;
@@ -423,7 +636,7 @@ export interface BlazeDataSourceType {
 	text?: string;
 }
 export type LocaleDirectionType = "LTR" | "RTL";
-export type OrderType = "Manual" | "AtoZ" | "ZtoA" | "RecentlyUpdatedFirst" | "RecentlyUpdatedLast" | "RecentlyCreatedFirst" | "RecentlyCreatedLast" | "Random";
+export type OrderType = "Manual" | "AtoZ" | "ZtoA" | "RecentlyUpdatedFirst" | "RecentlyUpdatedLast" | "RecentlyCreatedFirst" | "RecentlyCreatedLast" | "Random" | "Upcoming" | "RecentlyStartingFirst" | "RecentlyStartingLast" | "RecentlyStartedFirst" | "RecentlyStartedLast";
 export type ContentOrderType = "LIVE_CHIP" | "STORY_TITLE" | "PUBLISHED_DATE";
 export type BlazePersonalizedIds = {
 	type: "ids";
@@ -439,6 +652,18 @@ export type BlazePersonalized = BlazePersonalizedIds | BlazePersonalizedLabels;
 export type PrefetchingPolicyType = "low" | "default";
 export type ContentAspectRatio = "Vertical" | "Horizontal";
 export type StoryDirectionType = "PREV_STORY" | "NEXT_STORY" | "PREV_PAGE" | "NEXT_PAGE";
+/**
+ * Stream state indicates the current lifecycle stage of a live stream
+ *
+ * @remarks
+ * - 'Upcoming': Stream is scheduled but not yet started (waiting room)
+ * - 'Live': Stream is currently broadcasting (live playback)
+ * - 'Ended': Stream has finished (replay or ended state)
+ * - null: Regular content (not a stream -> video)
+ *
+ * Note: Uses capitalized format to match API response format
+ */
+export type StreamState = "Upcoming" | "Live" | "Ended" | null;
 export type ThumbnailApiType = "SquareIcon" | "VerticalTwoByThree" | "Gif" | "AnimatedThumbnailPoster" | "MainThumbnail";
 export type ThumbnailType = "SQUARE_ICON" | "VERTICAL_TWO_BY_THREE" | "GIF" | "ANIMATED_THUMBNAIL_POSTER" | "CUSTOM";
 export type ThumbnailShape = "Circle" | "Rectangle";
@@ -475,6 +700,7 @@ export interface IWidgetViewOptionsBase {
 	shouldOrderWidgetByReadStatus?: boolean;
 	contentIds?: string[];
 	actionHandlers?: ActionHandler[];
+	videoFilters?: IVideoFilterOptions;
 }
 export interface IWidgetViewOptionsWithLabels extends IWidgetViewOptionsBase {
 	labels: string | string[] | BlazeWidgetLabel;
@@ -591,6 +817,7 @@ export interface IContent {
 	extraInfo: ExtraInfo;
 	followEntities?: BlazeFollowEntity[];
 	retrievedLanguages?: RetrievedLanguages;
+	titleImageUrl?: string;
 }
 export interface IBlazeContent {
 	id: string;
@@ -601,6 +828,7 @@ export interface IBlazeContent {
 	hasViewed: boolean;
 	type?: string;
 	entities?: ContentEntities;
+	titleImageUrl?: string;
 }
 export interface IRendition {
 	url: string;
@@ -646,6 +874,7 @@ export interface IBlazeSDKOptions {
 	previewMomentUrl?: string;
 	doNotTrack?: boolean;
 	disableAnalytics?: boolean;
+	disableUserActivity?: boolean;
 	geoLocation?: string;
 	staticContent?: boolean;
 	staticContentType?: ContentType;
@@ -665,6 +894,8 @@ export interface IBlazeSDKOptions {
 	disableAutoLoadingContent?: boolean;
 	followedEntities?: string[];
 	preferredLanguage?: string;
+	/** Timeout in milliseconds for CDN requests. Minimum value is 10000ms — values below this threshold are ignored. */
+	cdnTimeout?: number;
 }
 export interface IDataSourceBuilder {
 	labels: (params: LabelsDataSourceParams) => BlazeDataSourceType;
@@ -721,6 +952,56 @@ export type BlazeVideoIconsStyle = BaseBlazeIcons & {
 		nextVideo: string;
 	};
 };
+/**
+ * Builder interface for creating video filter configurations
+ * Provides a fluent API for common filtering scenarios
+ *
+ * @example
+ * // Builder pattern (recommended)
+ * const filters = VideoFilterBuilder();
+ * videoFilters: filters.liveOnly()
+ * videoFilters: filters.watchable()
+ *
+ * @example
+ * // Custom filter with validation
+ * videoFilters: filters.custom({
+ *   contentTypes: ['Video', 'Stream'],
+ *   streamStates: ['Live', 'Ended']
+ * })
+ */
+export interface IVideoFilterBuilder {
+	/**
+	 * Only show currently live streams
+	 */
+	liveOnly(): IVideoFilterOptions;
+	/**
+	 * Only show upcoming scheduled streams
+	 */
+	upcomingOnly(): IVideoFilterOptions;
+	/**
+	 * Only show ended streams (replays)
+	 */
+	endedOnly(): IVideoFilterOptions;
+	/**
+	 * Show all streams regardless of state (live, upcoming, ended)
+	 */
+	allStreams(): IVideoFilterOptions;
+	/**
+	 * Only show on-demand video content (not streams)
+	 */
+	vodOnly(): IVideoFilterOptions;
+	/**
+	 * Show watchable content: on-demand videos + live streams
+	 * Excludes upcoming streams and ended streams (no replay URLs)
+	 */
+	watchable(): IVideoFilterOptions;
+	/**
+	 * Create custom filter configuration with validation
+	 * @param options - Custom filter options
+	 * @throws Error if filter configuration is invalid
+	 */
+	custom(options: IVideoFilterOptions): IVideoFilterOptions;
+}
 export interface IWidgetLabelBuilder {
 	singleLabel(label: string): BlazeWidgetLabel;
 	mustInclude(...labels: Array<string | BlazeWidgetLabel>): BlazeWidgetLabel;
@@ -814,6 +1095,7 @@ export declare function addDelegateListener(type: string, listener: EventListene
 export declare const Delegations: typeof Delegation;
 export declare function LabelBuilder(): IWidgetLabelBuilder;
 export declare function DataSourceBuilder(): IDataSourceBuilder;
+export declare function VideoFilterBuilder(): IVideoFilterBuilder;
 export declare function pauseCurrentPlayer(): void;
 export declare function resumeCurrentPlayer(): void;
 export declare function setGoogleCustomNativeAdsHandler(handler: CustomNativeAdHandler): void;
@@ -844,6 +1126,16 @@ export declare function appendContentToPlayer(contentType: ContentType, dataSour
  * @param value - true to disable analytics, false to enable
  */
 export declare function setDisableAnalytics(value: boolean): void;
+/**
+ * Clears all user activity data from the device's local storage only.
+ */
+export declare function clearLocalUserActivity(): Promise<void>;
+/**
+ * Enables or disables user activity tracking and syncing at runtime.
+ * Behavior when toggled:
+ * @param value - true to disable user activity, false to enable
+ */
+export declare function setDisableUserActivity(value: boolean): void;
 declare const _default: {
 	Initialize: typeof Initialize;
 	WidgetGridView: typeof WidgetGridView;
@@ -860,6 +1152,7 @@ declare const _default: {
 	setOnItemClick: typeof setOnItemClick;
 	LabelBuilder: typeof LabelBuilder;
 	DataSourceBuilder: typeof DataSourceBuilder;
+	VideoFilterBuilder: typeof VideoFilterBuilder;
 	Delegations: typeof Delegation;
 	setGoogleCustomNativeAdsHandler: typeof setGoogleCustomNativeAdsHandler;
 	setImaHandler: typeof setImaHandler;
@@ -875,6 +1168,8 @@ declare const _default: {
 	isInitialized: () => boolean;
 	setBeforeContentPlayCallback: typeof setBeforeContentPlayCallback;
 	appendContentToPlayer: typeof appendContentToPlayer;
+	clearLocalUserActivity: typeof clearLocalUserActivity;
+	setDisableUserActivity: typeof setDisableUserActivity;
 };
 
 export {