@tivio/sdk-react 9.2.0-alpha.4 → 9.2.0

package/dist/index.d.ts

@@ -1014,6 +1014,18 @@ export declare interface ConversionsTargetItem {
 
 export declare type CountdownScene = InteractiveWidgetSceneBase<InteractiveWidgetSceneTemplateType.COUNTDOWN>;
 
+/**
+ * Maps supported country codes (ISO 3166-1 alpha-2) to their primary language codes (ISO 639-1).
+ * Used to determine the default language settings for specific countries.
+ * @example
+ * CountryToLanguageMap['CZ'] // Returns LangCode.CS for Czech Republic
+ */
+export declare const CountryToLangCodeMap: {
+    CZ: LangCode;
+    PL: LangCode;
+    SK: LangCode;
+};
+
 /**
  * @public
  * @TODO move somewhere else
@@ -1034,11 +1046,11 @@ export declare const createPubSub: () => PubSub;
  * Fetch & load CommonJS remote module.
  * @public
  */
-export declare const createRemotePackageLoader: () => (secret: string, conf: InternalConfig, checkBundleCharCount?: boolean) => Promise<TivioBundle>;
+export declare const createRemotePackageLoader: () => (secret: string, conf: InternalConfig, checkBundleCharCount?: boolean, skipCache?: boolean) => Promise<TivioBundle>;
 
 export declare const createTivio: () => (conf: SdkReactConfig) => Promise<RemoteBundleState>;
 
-export declare const createUseRemoteBundle: () => (sdkReactConfig: SdkReactConfig, checkBundleCharCount?: boolean) => RemoteBundleState;
+export declare const createUseRemoteBundle: () => (sdkReactConfig: SdkReactConfig, checkBundleCharCount?: boolean, skipCache?: boolean) => RemoteBundleState;
 
 export declare interface CreateUserPayload {
     displayName?: string;
@@ -1114,7 +1126,6 @@ export declare enum CustomerId {
     GRAPE = "GRAPE",
     HODINA_DEJEPICHU = "HODINA_DEJEPICHU",
     INVESTICNI_PRUVODCE = "INVESTICNI_PRUVODCE",
-    INVESTOREES = "INVESTOREES",
     JOJ = "JOJ",
     KLUCI_Z_PRAHY = "KLUCI_Z_PRAHY",
     MALL = "MALL",
@@ -1159,7 +1170,8 @@ export declare enum CustomerId {
     BEAT_SEXISM = "BEAT_SEXISM",
     KAROL_A_KVIDO = "KAROL_A_KVIDO",
     UZ_BUDU = "UZ_BUDU",
-    PRIMA = "PRIMA"
+    PRIMA = "PRIMA",
+    NORA_FRIDRICHOVA = "NORA_FRIDRICHOVA"
 }
 
 export declare interface CustomScript {
@@ -1291,6 +1303,8 @@ export declare enum DrmProvider {
      * Original oktagon stream provider.
      *
      * https://streamonline.pl
+     *
+     * @deprecated oktagon no longer uses this drm provider.
      */
     STREAMONLINE = "streamonline"
 }
@@ -1434,8 +1448,8 @@ export declare type EmbedScreenPostMessageFn = <T extends EmbedScreenPostMessage
  */
 export declare interface EmitterInterface {
     isSupported: (even: string) => boolean;
-    addListener: <T = any>(event: string, cb: (value: T) => Empty_2) => void;
-    removeListener: <T = any>(event: string, cb: (value: T) => Empty_2) => void;
+    addListener: <T = unknown>(event: string, cb: (value: T) => Empty_2) => void;
+    removeListener: <T = unknown>(event: string, cb: (value: T) => Empty_2) => void;
 }
 
 /**
@@ -3117,9 +3131,8 @@ export declare interface PlayerEngineInterface {
     stop(): Promise<void>;
     addEventListener<T>(event: PlayerEngineEvent, callback: PlayerEngineListener<T>): void;
     addEventListener(event: 'statechange', callback: PlayerEngineListener<PlayerState>): void;
-    addEventListener(event: 'bufferingchange', callback: PlayerEngineListener<boolean>): void;
+    addEventListener(event: 'bufferingchange' | 'togglefullscreen', callback: PlayerEngineListener<boolean>): void;
     addEventListener(event: 'bufferedinfochange', callback: PlayerEngineListener<BufferPercentChunk[]>): void;
-    addEventListener(event: 'togglefullscreen', callback: PlayerEngineListener<boolean>): void;
     removeEventListener<T>(event: PlayerEngineEvent, listener: PlayerEngineListener<T>): void;
     /**
      * @returns currently playing audio track in ISO 639-1 format ('cs', 'en' etc.) or null if not available
@@ -3203,7 +3216,7 @@ export declare interface PlayerEngineInterface {
 /**
  * @public
  */
-export declare type PlayerEngineListener<T> = (value: T) => any;
+export declare type PlayerEngineListener<T> = (value: T) => void;
 
 /**
  * @public
@@ -3970,6 +3983,14 @@ export declare type PurchaseEndpointPayload = {
     };
 };
 
+/**
+ * @public
+ */
+export declare type PurchaseEventHandlers = {
+    onPurchaseIntention?: (purchase: PurchasableMonetization) => void;
+    onPurchaseFinished?: (purchase: Purchase) => void;
+};
+
 /**
  * @public
  */
@@ -4404,7 +4425,7 @@ export declare interface RenderConditionValue {
     subscriptionRefs?: any[];
 }
 
-export declare const renderWebPlayer: (container: HTMLElement, props: WebPlayerProps) => void;
+export declare const renderWebPlayer: (container: HTMLElement, props: Omit<WebPlayerProps, 'onPlayerControllerCreated'>) => Promise<SimplifiedVideoController>;
 
 /**
  * Make all attributes in given type required, non-nullable and defined.
@@ -4788,6 +4809,7 @@ declare interface Screen_2 {
     fetchMoreRows: () => Promise<void>;
     hasNextPage: boolean;
     refetchIfNeeded: () => Promise<void>;
+    allowOrganizationBanner?: boolean;
 }
 export { Screen_2 as Screen }
 
@@ -5037,6 +5059,110 @@ export declare const showGdprConsentPreferences: () => Promise<void>;
  */
 export declare type SignInProvider = 'google' | 'patreon' | 'apple';
 
+/**
+ * Simplified VideoController interface for external rendering
+ */
+export declare interface SimplifiedVideoController {
+    /**
+     * Resume playback from paused state
+     */
+    play(): void;
+    /**
+     * Pause the current playback
+     */
+    pause(): void;
+    /**
+     * Toggle between play and pause states
+     */
+    togglePause(): void;
+    /**
+     * Replay the current video from the beginning
+     */
+    replay(): Promise<void>;
+    /**
+     * Retry playback if it failed to start
+     */
+    retry(): void;
+    /**
+     * Seek to an absolute position in milliseconds
+     * @param ms - Position in milliseconds from the start of the video
+     */
+    seekToAbsolutePosition(ms: number): void;
+    /**
+     * Seek relative to current position
+     * @param ms - Number of milliseconds to seek (positive for forward, negative for backward)
+     */
+    seekBy(ms: number): void;
+    /**
+     * Seek to a percentage of the video duration
+     * @param percentage - Percentage value between 0 and 100
+     */
+    seekToPercent(percentage: number): void;
+    /**
+     * Seek to the live position for live streams
+     */
+    seekToLive(): void;
+    /**
+     * Set the volume level
+     * @param value - Volume level between 0 and 1
+     */
+    changeVolume(value: number): void;
+    /**
+     * Increase volume by 5%
+     */
+    volumeUp(): void;
+    /**
+     * Decrease volume by 5%
+     */
+    volumeDown(): void;
+    /**
+     * Mute the audio
+     */
+    mute(): void;
+    /**
+     * Unmute the audio
+     */
+    unmute(): void;
+    /**
+     * Toggle between muted and unmuted states
+     */
+    toggleMute(): void;
+    /**
+     * Currently playing source or null if no source is loaded
+     */
+    readonly currentSource: PlayerSource | null;
+    /**
+     * Add an event listener for player events
+     * @param event - The event name to listen for (e.g., 'ended', 'timeupdate', 'statechange')
+     * @param callback - Function to call when the event occurs
+     */
+    addEventListener<T>(event: string, callback: (value: T) => void): void;
+    /**
+     * Add an event listener for volume changes
+     * @param event - Must be 'volumechange'
+     * @param callback - Function called with volume state object
+     */
+    addEventListener(event: 'volumechange', callback: (value: {
+        muted: boolean;
+        volume: number;
+    }) => void): void;
+    /**
+     * Remove an event listener
+     * @param event - The event name to stop listening for
+     * @param callback - The callback function to remove
+     */
+    removeEventListener<T>(event: string, callback: (value: T) => void): void;
+    /**
+     * Change the current source to a new one
+     * @param source - The new source to load (can be a video path, channel path, or source parameters)
+     */
+    setSource(source: WebPlayerProps['source']): void;
+    /**
+     * Destroy the player and clean up all resources
+     */
+    destroy(): Promise<void>;
+}
+
 export declare enum SocialNetworks {
     FACEBOOK = 0,
     INSTAGRAM = 1,
@@ -5522,7 +5648,6 @@ export declare interface TivioComponents {
     }>;
     Provider: React_2.ComponentType<RemoteProviderProps>;
     WebPlayer: React_2.ComponentType<WebPlayerProps>;
-    Widget: React_2.ComponentType<TivioWidgetProps>;
     PlayerDataContextProvider: React_2.ComponentType<{
         id: string;
     }>;
@@ -5551,9 +5676,7 @@ export declare interface TivioComponents {
     WebTile: React_2.ComponentType<{
         item?: ItemInRow;
     } & TilePropsPartial>;
-    ChannelContext: React_2.Context<TvChannel | undefined>;
     ContentSortPicker: React_2.ComponentType<ContentSortPickerProps>;
-    WebProfileScreen: React_2.ComponentType<WebProfileScreenProps>;
     WebTivioProVideoScreen: React_2.ComponentType<WebTivioProVideoScreenProps>;
     RemoteController: React_2.ComponentType<RemoteControllerProps>;
 }
@@ -5579,14 +5702,24 @@ export declare interface TivioConfig {
         preferHttp?: boolean;
     };
     secret: string;
+    /**
+     * Language used when isLanguageSelectionEnabled is false | undefined or when not possible to load language from local storage or localization worker
+     */
     language: LangCode;
     debug?: boolean;
     verbose?: boolean;
     firebaseApp?: any | null;
-    firebaseFactory?: (config: Object, appName?: string) => firebase_2.FirebaseApp;
+    firebaseFactory?: (config: object, appName?: string) => firebase_2.FirebaseApp;
     authDomainOverride?: string;
     firestore?: any | null;
     currency: Currency;
+    /**
+     * A flag that indicates whether the language selection feature is enabled.
+     * Language is then stored to local storage 'tivio-user-language'.
+     * If nothing is stored in local storage, then language is set according to location
+     * When set to `true`, users are allowed to choose their preferred language
+     */
+    isLanguageSelectionEnabled?: boolean;
     applicationId?: string;
     isTivioProApp?: boolean;
     lockApplicationHandle?: string;
@@ -5812,6 +5945,9 @@ export declare type TivioInternalProviders = {
     }>;
     MonetizationsSelectOverlayContextProvider: React_2.ComponentType;
     QerkoOverlayContextProvider: React_2.ComponentType;
+    /**
+     * @deprecated do not use, this provider will be removed in the future
+     */
     PurchasesWithVideosContextProvider: React_2.ComponentType<{
         children?: React_2.ReactNode;
     }>;
@@ -5969,55 +6105,6 @@ export declare type TivioVodSource = SourceBase & StartAndContinuePosition & {
     videoPath: string;
 };
 
-/**
- * @public
- */
-export declare const TivioWidget: React_2.ForwardRefExoticComponent<Omit<TivioWidgetProps, "ref"> & React_2.RefAttributes<TivioWidgetRef>>;
-
-/**
- * @public
- */
-export declare const TivioWidgetError: React_2.FC<TivioWidgetErrorProps>;
-
-declare type TivioWidgetErrorProps = {
-    error: string | null;
-};
-
-/**
- * @public
- */
-export declare const TivioWidgetLoader: React_2.FC;
-
-/**
- * @public
- */
-export declare interface TivioWidgetProps {
-    id: string;
-    ref: React_2.MutableRefObject<TivioWidgetRef>;
-    onEnabled?: (enabled: boolean) => any;
-    onBlur?: (event: {
-        key: string;
-        width: number;
-        x: number;
-    }) => any;
-}
-
-/**
- * @public
- */
-export declare interface TivioWidgetRef {
-    focus: (args: {
-        x?: number;
-    }) => void;
-    handleKey: (key: string) => ({
-        handled: boolean;
-        x: number;
-    });
-    unfocus: () => ({
-        x: number;
-    });
-}
-
 export declare interface TokenInterface {
     token: string;
     expirationDate: Date;
@@ -6954,6 +7041,154 @@ export declare enum VideoContentType {
     SERIES = "SERIES"
 }
 
+/**
+ * @public
+ * VideoController provides control over video playback, seeking, volume, and event handling.
+ */
+export declare interface VideoController {
+    /** Unique identifier for this player instance */
+    readonly playerId: string;
+    /** Internal control queue for managing player operations */
+    readonly controlQueue: unknown;
+    /** Currently playing source or null if no source is loaded */
+    readonly currentSource: PlayerSource | null;
+    /**
+     * Add an event listener for player events
+     * @param event - The event name to listen for (e.g., 'ended', 'timeupdate', 'statechange')
+     * @param callback - Function to call when the event occurs
+     */
+    addEventListener<T>(event: string, callback: (value: T) => void): void;
+    addEventListener(event: 'volumechange', callback: (value: {
+        muted: boolean;
+        volume: number;
+    }) => void): void;
+    /**
+     * Remove an event listener
+     * @param event - The event name to stop listening for
+     * @param callback - The callback function to remove
+     */
+    removeEventListener<T>(event: string, callback: (value: T) => void): void;
+    /**
+     * Change the current source to a new one
+     * @param sourceData - The new source parameters
+     * @param autoplay - Whether to start playing immediately (default: true)
+     * @returns Promise that resolves to the new source or null if failed
+     */
+    changeSource(sourceData: SourceParams, autoplay?: boolean): Promise<PlayerSource | null>;
+    /**
+     * Load a new source and optionally start playing
+     * @param sourceData - The source parameters to load
+     * @param autoplay - Whether to start playing immediately
+     */
+    load(sourceData: SourceParams, autoplay: boolean): Promise<void>;
+    /**
+     * Toggle between play and pause states
+     */
+    togglePause(): void;
+    /**
+     * Pause the current playback
+     */
+    pause(): void;
+    /**
+     * Resume playback from paused state
+     */
+    unpause(): void;
+    /**
+     * Replay the current video from the beginning
+     */
+    replay(): Promise<void>;
+    /**
+     * Retry playback if it failed to start
+     */
+    retry(): void;
+    /**
+     * Stop playback and reset player state
+     */
+    close(): void;
+    /**
+     * Destroy the player and clean up all resources
+     */
+    destroy(): Promise<void>;
+    /**
+     * Seek to an absolute position in milliseconds
+     * @param ms - Position in milliseconds from the start of the video
+     */
+    seekToAbsolutePosition(ms: number): void;
+    /**
+     * Seek relative to current position
+     * @param ms - Number of milliseconds to seek (positive for forward, negative for backward)
+     */
+    seekBy(ms: number): void;
+    /**
+     * Seek to a percentage of the video duration
+     * @param percentage - Percentage value between 0 and 100
+     */
+    seekToPercent(percentage: number): void;
+    /**
+     * @deprecated Use seekToPercent instead
+     * Seek to a relative position as percentage of video duration
+     * @param percentage - Percentage value between 0 and 100
+     */
+    seekToRelativePosition(percentage: number): void;
+    /**
+     * Seek to the live position for live streams
+     */
+    seekToLive(): void;
+    /**
+     * Internal method to seek to live position
+     */
+    seekToLiveInternal(): void;
+    /**
+     * Set the volume level
+     * @param value - Volume level between 0 and 1
+     */
+    changeVolume(value: number): void;
+    /**
+     * Increase volume by 5%
+     */
+    volumeUp(): void;
+    /**
+     * Decrease volume by 5%
+     */
+    volumeDown(): void;
+    /**
+     * Mute the audio
+     */
+    mute(): void;
+    /**
+     * Unmute the audio
+     */
+    unmute(): void;
+    /**
+     * Toggle between muted and unmuted states
+     */
+    toggleMute(): void;
+    /**
+     * Enter fullscreen mode
+     */
+    goFullScreen(): Promise<void>;
+    /**
+     * @deprecated Use durationchange event instead
+     * Set the duration of the current video in milliseconds
+     * @param ms - Duration in milliseconds
+     */
+    setDurationMs(ms: number): void;
+    /**
+     * Get the duration of the current video in milliseconds
+     * @returns Duration in milliseconds
+     */
+    getDurationMs(): number;
+    /** Whether live seeking is enabled for the current source */
+    readonly isLiveSeekingEnabled: boolean;
+    /** Whether the current playback position is live */
+    readonly isCurrentTimeLive: boolean;
+    /**
+     * Handle watermark element changes for security purposes
+     * @param mutations - Array of DOM mutation records
+     */
+    onWatermarkElementChange(mutations: MutationRecord[]): void;
+}
+
 declare type VideoDetailResponsiveField = OrganizationResponsiveSetting<{
     modalView?: boolean;
     showDateOfPublicationForRelatedVideos?: boolean;
@@ -7511,6 +7746,10 @@ export declare interface WebConfig {
             [key: string]: string;
         };
     };
+    /**
+     * Map for all handlers
+     */
+    handlers?: PurchaseEventHandlers;
 }
 
 /**
@@ -7576,10 +7815,7 @@ export declare interface WebPlayerProps {
      */
     enableKeyboardShortcuts?: boolean;
     onProgress?: (event: React_2.ChangeEvent<HTMLVideoElement>) => void;
-    /**
-     * @deprecated this callback is never called. Will be removed in @tivio/sdk-react version 4
-     */
-    onPlayerControllerCreated?: (playerController: any) => void;
+    onPlayerControllerCreated?: (playerController: VideoController) => void;
     /**
      * If true, saving of watch position won't be performed.
      */