@tivio/sdk-react 6.0.1 → 7.0.0

package/dist/sdk-react.d.ts

@@ -3,6 +3,7 @@ import { FunctionComponentElement } from 'react';
 import { GeoPoint } from '@firebase/firestore-types';
 import { OperatingSystem } from 'detect-browser';
 import { default as React_2 } from 'react';
+import { RecommendationsQuery } from '@algolia/recommend';
 
 /**
  * @public
@@ -60,13 +61,37 @@ export declare type AdMetadata = {
 /**
  * @public
  */
-export declare interface AdMonetization extends Monetization {
+export declare type AdMonetization = Monetization;
+
+export declare interface AdPackInfo {
+    order: number;
+    total: number;
+}
+
+export declare interface AdSegment {
+    id: string;
+    /**
+     * @deprecated alias to secondsToEnd * 1000
+     */
+    remainingMs: number;
+    secondsToEnd: number;
+    secondsToSkippable: number | null;
+    canSeek: boolean;
+    /**
+     * true if is skippable and skip countdown has passed
+     */
+    canSkip: boolean;
+    /**
+     * true ad if is skippable after some skipDelayMs (if it is skippable, skipDelayMs is defined)
+     */
+    isSkippable: boolean;
+    skip: () => any;
 }
 
 /**
  * @public
  */
-declare type AdSegment = {
+declare type AdSegment_2 = {
     id: string;
     /**
      * @deprecated alias to secondsToEnd * 1000
@@ -89,17 +114,27 @@ declare type AdSegment = {
 /**
  * @public
  */
-export declare type AdSource = {
-    new (url: string, name: string, description: string, skipDelayMs: number | null, adDurationMs: number, trackingContext?: any, // internal Tivio types
-    adMarker?: any, // internal Tivio types
-    packInfo?: any, // internal Tivio types
-    provider?: any): AdSource;
-    description: string;
-    name: string;
-    url: string;
+declare type AdSource = SourceBase & {
+    type: 'ad';
+};
+
+export declare interface AdSourceActions {
+    click: () => void;
+    skip: () => void;
+    skipAll: () => void;
+    resumeAd: () => void;
+    pauseAd: () => void;
+    muteAd: () => void;
+    unmuteAd: () => void;
+}
+
+/**
+ * @public
+ */
+export declare interface AdSourceInterface extends CommonSourceInterface<SourceType.ADVERTISEMENT> {
+    adType: AdType;
     durationMs: number;
     skipDelayMs: number | null;
-    type: 'ad';
     /**
      * true if is skippable and skip countdown has passed
      */
@@ -108,6 +143,10 @@ export declare type AdSource = {
      * true ad if is skippable after some skipDelayMs (if it is skippable, skipDelayMs is defined)
      */
     isSkippable: boolean;
+    isSkipped: boolean;
+    isPaused: boolean;
+    isMuted: boolean;
+    setIsPaused(isPaused: boolean): void;
     /**
      * Skip ad. Only works when canSkip is true
      */
@@ -115,21 +154,47 @@ export declare type AdSource = {
     /**
      * Order in ad break (ad break is a group of ads played right after each other)
      */
-    order: number;
+    order: number | null;
     /**
      * Total number of ads in ad break (ad break is a group of ads played right after each other)
      */
-    totalCount: number;
+    totalCount: number | null;
     secondsToEnd: number;
     secondsToSkippable: number | null;
-};
+    provider?: VastProvider;
+    apiFramework: VastApiFramework | null;
+    parent: PlayerSourceInterface | null;
+    trackingContext: any | null;
+    resumeAd(): void;
+    pauseAd(): void;
+    muteAd(): void;
+    unmuteAd(): void;
+    skipAll(): void;
+    onRemainingTimeChanged(ms: number): void;
+    click(): void;
+}
 
 /**
  * @public
  */
-declare type AdSource_2 = SourceBase & {
-    type: 'ad';
-};
+export declare interface AdSourceParams extends CommonSourceParams<SourceType.ADVERTISEMENT> {
+    id: string;
+    adType?: AdType;
+    actions?: AdSourceActions | null;
+    apiFramework?: VastApiFramework | null;
+    skipDelayMs?: number | null;
+    adDurationMs: number;
+    trackingContext?: any;
+    adMarker?: any;
+    packInfo?: AdPackInfo;
+    provider?: VastProvider;
+    parent?: PlayerSource | null;
+}
+
+/**
+ * @public
+ */
+export declare type AdType = 'playable' | 'metadata-only';
 
 /**
  * @public
@@ -344,6 +409,7 @@ export declare const bundlePromise: Promise<RemoteBundleState>;
 export declare type ButtonOptions = {
     backgroundImage: string;
     borderRadius: string | number;
+    color?: string;
 };
 
 /**
@@ -353,6 +419,7 @@ export declare type Callback<T = any> = (arg?: T) => void;
 
 /**
  * @public
+ * @deprecated this channel structure is not used anymore (don't confuse with tv channels, which are used).
  */
 export declare interface Channel {
     id: string;
@@ -362,36 +429,33 @@ export declare interface Channel {
     recentVideos: Video[];
 }
 
+declare type ChannelPath = string;
+
 /**
  * @public
  */
-export declare type ChannelSource = {
-    new (url: string, originalOptions: Record<string, any>, channelName: string, programName: string, programDescription: string, from: Date, to: Date): ChannelSource;
-    description: string;
-    name: string;
-    url: string;
-    from: Date;
+export declare interface ChannelSourceInterface extends PlayerSourceInterface<SourceType.CHANNEL> {
+    tvChannelType: TvChannelType;
     channelName: string;
+    programName?: string;
+    programDescription?: string;
+    from: Date;
     to: Date;
-    type: 'channel';
-    watchWithoutAdsRecommendation: {
-        showPurchaseDialog: () => void;
-    } | null;
-};
+    poster: string | null;
+    tvMode: TvMode | 'live' | null;
+}
 
 /**
  * @public
  */
-export declare interface ChannelSourcePojo {
-    type: 'ChannelSource';
-    url: string;
-    originalOptions: any;
+export declare interface ChannelSourceParams extends PlayerSourceParams<SourceType.CHANNEL> {
+    tvChannelType: TvChannelType;
     channelName: string;
-    programName: string;
-    programDescription: string;
+    programName?: string;
+    programDescription?: string;
     from: Date;
     to: Date;
-    poster?: string;
+    tvMode?: TvMode | 'live' | null;
 }
 
 /**
@@ -404,6 +468,47 @@ export declare type Chapter = any;
  */
 export declare type CmpConfig = 'default' | 'debug' | 'none';
 
+/**
+ * TODO same name as core-js entity, not convenient
+ * @public
+ */
+export declare type CommonSource = PlayerSource | AdSourceInterface;
+
+/**
+ * Use this interface only for inheritance. Otherwise use {@link CommonSource}
+ * @public
+ */
+export declare interface CommonSourceInterface<T extends SourceType = SourceType> {
+    type: T;
+    url: string;
+    name?: string;
+    description?: string;
+    currentTime: number;
+    event: any | null;
+    setEvent(event: any | null): void;
+    onTimeChanged(ms: number): void;
+    next: CommonSource | null;
+    canSeek: boolean;
+    hasNext: boolean;
+    isFinished: boolean;
+    setIsFinished(isFinished: boolean): void;
+    isStarted: boolean;
+    setIsStarted(isStarted: boolean): void;
+    autoplay?: boolean;
+    toLog(): any;
+}
+
+/**
+ * @public
+ */
+export declare interface CommonSourceParams<T extends SourceType = SourceType> {
+    type: T;
+    url: string;
+    name?: string;
+    description?: string;
+    autoplay?: boolean;
+}
+
 /**
  * TODO it's the same as Customizations, not?
  * @internal
@@ -457,6 +562,46 @@ export declare interface ConfirmationOverlayPayloadBase {
     automaticConfirmDelayMs?: number;
 }
 
+/**
+ * @public
+ */
+export declare interface ConsumedAds {
+    chapterIds: Set<string>;
+    markerIds: Set<string>;
+    postroll: boolean;
+    /**
+     * TODO refactor
+     * true when preroll has been loaded (not when it was watched)
+     */
+    preroll: boolean;
+}
+
+/**
+ * @public
+ */
+export declare enum ContentSortEnum {
+    LATEST = "latest",
+    OLDEST = "oldest",
+    A_TO_Z = "a_to_z",
+    Z_TO_A = "z_to_a",
+    EPISODE_ASC = "episode_asc",
+    EPISODE_DESC = "episode_desc"
+}
+
+/**
+ * @public
+ */
+export declare type ContentSortPickerProps = {
+    value: ContentSortEnum;
+    isSeries?: boolean;
+    onChange: (value: ContentSortEnum) => void;
+};
+
+/**
+ * @public
+ */
+export declare type ContinuePosition = number | null | Promise<number | null>;
+
 /**
  * Entity aggregate conversion statistics per day
  * TODO in future change structure, new used like array item
@@ -588,7 +733,9 @@ export declare enum CustomerId {
     GRAPE = "GRAPE",
     TIVIO = "TIVIO",
     STORYBOOK = "STORYBOOK",
-    NANGU_DEV = "NANGU_DEV"
+    NANGU_DEV = "NANGU_DEV",
+    CNC = "CNC",
+    VOJTA_ZIZKA = "VOJTA_ZIZKA"
 }
 
 /**
@@ -617,6 +764,7 @@ export declare type Customizations = {
              */
             fontSize: number;
         };
+        borderRadius: string | number;
     };
     SplitBanner: {
         height: string;
@@ -642,6 +790,7 @@ export declare type Customizations = {
         activeLinkUnderlineColor: string;
         logoHeight: string;
         borderBottom: string;
+        color?: string;
     };
     VideoDetail: {
         Banner: {
@@ -671,6 +820,13 @@ export declare type Customizations = {
              */
             title: string;
         };
+        /**
+         * Customizations for attributes eg. contentType, year, genres, duration, tags
+         */
+        AttributeTexts?: {
+            color: string;
+            mobileColor?: string;
+        };
     };
     Input: InputOptions;
     landing: {
@@ -691,6 +847,14 @@ export declare type Customizations = {
          * Background style of success icon on "/pair" site.
          */
         pairSuccessBackground: string;
+        /**
+         * Main application font color.
+         */
+        appColor: string;
+    };
+    Avatar?: {
+        backgroundColor: string;
+        color: string;
     };
 };
 
@@ -712,6 +876,19 @@ export declare interface CustomThemeOptions {
     size: (size: number) => number;
 }
 
+/**
+ * @public
+ */
+export declare interface Cutout {
+    startMs: number;
+    endMs: number;
+}
+
+/**
+ * @public
+ */
+export declare const DEFAULT_LIMIT = 10;
+
 /**
  * @public
  */
@@ -891,6 +1068,35 @@ export declare interface EmailTemplateVersion {
     thumbnail_url: string;
 }
 
+export declare type EmbedScreenMessageNavigateType = {
+    type: EmbedScreenMessageType.NAVIGATE;
+    to: string | 'Profile' | 'Home' | 'Search' | 'Video' | 'Series';
+    value?: string;
+};
+
+export declare type EmbedScreenMessageResizeType = {
+    type: EmbedScreenMessageType.RESIZE;
+    height: number;
+};
+
+export declare enum EmbedScreenMessageType {
+    RESIZE = "RESIZE",
+    NAVIGATE = "NAVIGATE"
+}
+
+export declare type EmbedScreenPostMessage = EmbedScreenMessageNavigateType | EmbedScreenMessageResizeType;
+
+export declare type EmbedScreenPostMessageFn = <T extends EmbedScreenPostMessage = EmbedScreenPostMessage>(message: T, origin?: string) => void;
+
+/**
+ * @public
+ */
+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;
+}
+
 /**
  * @public
  */
@@ -973,11 +1179,9 @@ export declare interface GetBaseAnalyticsRequest {
     endDate: string;
 }
 
-export declare interface GetConversionAnalyticsRequest extends GetBaseAnalyticsRequest {
-}
+export declare type GetConversionAnalyticsRequest = GetBaseAnalyticsRequest;
 
-export declare interface GetMonetizationsAnalyticsRequest extends GetBaseAnalyticsRequest {
-}
+export declare type GetMonetizationsAnalyticsRequest = GetBaseAnalyticsRequest;
 
 export declare interface GetMonetizationsAnalyticsResponse {
     monetizationsAnalytics: MonetizationSummaryItem[];
@@ -1049,6 +1253,10 @@ export declare interface GetSourceUrlRequest {
      * construct sources based on source domains right away.
      */
     ignoreDocumentSources?: boolean;
+    /**
+     * See {@link SourcePlayMode} type. If not given, getSourceUrl will pick default based on requested document.
+     */
+    sourcePlayMode?: SourcePlayMode;
 }
 
 export declare interface GetSourceUrlResponse {
@@ -1064,6 +1272,62 @@ export declare interface GetSourceUrlResponse {
      * DRM configuration to {@link url} if source is encrypted.
      */
     drm?: Drm;
+    /**
+     * See {@link SourcePlayMode} type.
+     */
+    sourcePlayMode: SourcePlayMode;
+}
+
+export declare interface GetVideoAnalyticsErrorItem {
+    count: number;
+    timestamp: number;
+    errorMessage: string;
+}
+
+export declare interface GetVideoAnalyticsErrorResult {
+    totalCount: number;
+    errors: Array<GetVideoAnalyticsErrorItem>;
+}
+
+export declare interface GetVideoAnalyticsRequest {
+    contentId: string;
+    timestamp?: number;
+    userId?: string;
+    source?: string;
+    limit?: number;
+    errorLimit?: number;
+    errorTimestampFrom?: number;
+}
+
+export declare interface GetVideoAnalyticsResponse {
+    state?: GetVideoAnalyticsResult;
+    quality?: GetVideoAnalyticsResult;
+    error?: GetVideoAnalyticsErrorResult;
+    localities?: unknown;
+}
+
+export declare type GetVideoAnalyticsResult = {
+    [timestamp: string]: {
+        totalDuration: number;
+        values: Array<{
+            value: string;
+            duration: number;
+            percentage: number;
+        }>;
+    };
+};
+
+export declare interface GetVideoAnalyticsViewsRequest {
+    contentId: string;
+    currentViewsIntervalMs: number;
+    timestamp?: number;
+    source?: string;
+}
+
+export declare interface GetVideoAnalyticsViewsResponse {
+    previousViews?: number;
+    currentViews?: number;
+    totalViews?: number;
 }
 
 export declare interface GetViewAnalyticsResponse {
@@ -1071,7 +1335,15 @@ export declare interface GetViewAnalyticsResponse {
     topWatched: TopWatchItem[];
 }
 
-export declare interface GetViewsAnalyticsRequest extends GetBaseAnalyticsRequest {
+export declare type GetViewsAnalyticsRequest = GetBaseAnalyticsRequest;
+
+/**
+ * @public
+ */
+export declare enum GRID_TYPES {
+    ROW = "ROW",
+    VIDEO = "VIDEO",
+    SERIES = "SERIES"
 }
 
 /**
@@ -1122,6 +1394,7 @@ export declare interface IndexedUser extends IndexedObject {
 export declare interface IndexedVideo extends IndexedObject {
     assets: any;
     organizationPath: string;
+    sharedOrganizationPaths?: string[];
     tagPaths?: string[];
     created: Date | string;
     isDraft: boolean;
@@ -1141,11 +1414,6 @@ export declare type InputOptions = {
     borderRadius: string;
 };
 
-/**
- * @public
- */
-export declare type InputSource = AdSource | ChannelSource | VodTivioSource | VodExternalSource;
-
 /**
  * @public
  */
@@ -1185,6 +1453,37 @@ declare interface IntroMarker {
     skip: () => void;
 }
 
+/**
+ * @public
+ * @param source
+ */
+export declare function isAdSource(source?: CommonSource | null): source is AdSourceInterface;
+
+/**
+ * @public
+ */
+export declare function isChannelSource(source?: CommonSource | null): source is ChannelSourceInterface;
+
+/**
+ * @public
+ */
+export declare const isClassicChannelSource: (source?: CommonSource | null) => source is ChannelSourceInterface;
+
+/**
+ * @public
+ */
+export declare const isVirtualChannelSource: (source?: CommonSource | null) => source is VirtualChannelSourceInterface;
+
+/**
+ * @public
+ */
+export declare function isVodExternalSource(source?: CommonSource | null): source is VodExternalSourceInterface;
+
+/**
+ * @public
+ */
+export declare function isVodTivioSource(source?: CommonSource | null): source is VodTivioSourceInterface;
+
 /**
  * @public
  */
@@ -1391,6 +1690,18 @@ export declare interface Monetization {
     description?: string;
 }
 
+/**
+ * @public
+ */
+export declare enum MONETIZATION_DURATION {
+    UNLIMITED = -1,
+    DAY = 1,
+    WEEK = 7,
+    MONTH = 30,
+    HALF_YEAR = 183,
+    YEAR = 365
+}
+
 /**
  * @public
  */
@@ -1508,6 +1819,11 @@ export declare type NewVoucher = {
     expirationDate: Date | number;
 };
 
+/**
+ * @public
+ */
+export declare type NonAdSourceType = Exclude<SourceType, SourceType.ADVERTISEMENT>;
+
 declare interface Notification_2 {
     id: string;
     name: string;
@@ -1559,8 +1875,8 @@ export declare type OptionalKeys<T> = {
 /**
  * @public
  */
-export declare interface OrderBy {
-    field: string;
+export declare interface OrderBy<T = void> {
+    field: T extends void ? string : T;
     directionStr?: OrderByDirection;
 }
 
@@ -1731,12 +2047,12 @@ export declare interface PlayerEngineConfig {
 /**
  * @public
  */
-export declare type PlayerEngineEvent = 'bufferingchange' | 'bufferedinfochange' | 'statechange' | 'loaded' | 'loadfailed' | 'togglefullscreen' | 'durationchange' | 'busychange' | 'trackschanged' | 'abort' | 'canplay' | 'canplaythrough' | 'emptied' | 'ended' | 'error' | 'loadeddata' | 'loadedmetadata' | 'loadstart' | 'pause' | 'play' | 'playing' | 'progress' | 'ratechange' | 'seeked' | 'seeking' | 'stalled' | 'suspend' | 'timeupdate' | 'volumechange' | 'waiting' | 'click' | 'fullscreenchange';
+export declare type PlayerEngineEvent = 'bufferingchange' | 'bufferedinfochange' | 'statechange' | 'loaded' | 'loadfailed' | 'togglefullscreen' | 'durationchange' | 'busychange' | 'trackschanged' | 'abort' | 'canplay' | 'canplaythrough' | 'emptied' | 'enginedurationchange' | 'enginetimeupdate' | 'ended' | 'error' | 'loadeddata' | 'loadedmetadata' | 'loadstart' | 'pause' | 'play' | 'playing' | 'progress' | 'ratechange' | 'seeked' | 'seeking' | 'stalled' | 'suspend' | 'timeupdate' | 'volumechange' | 'waiting' | 'click' | 'fullscreenchange';
 
 /**
  * @public
  */
-export declare type PlayerEngineFactory = (videoElement: HTMLVideoElement) => PlayerEngineInterface;
+export declare type PlayerEngineFactory = (videoElement: HTMLVideoElement) => Promise<PlayerEngineInterface>;
 
 /**
  * @public
@@ -1846,36 +2162,66 @@ export declare interface PlayerEngineOptions {
     seekDebounceMs?: number;
 }
 
+export declare interface PlayerError {
+    message: string;
+}
+
 /**
  * @public
  */
 export declare interface PlayerInterface {
+    /**
+     * Pause playback
+     */
     pause: () => void;
     /**
-     * unpause
+     * Unpause playback
      */
-    play: () => void;
+    play: () => Promise<void> | void;
     /**
+     * Stop and close video
+     */
+    stop: () => Promise<void> | void;
+    /**
+     * Seek to position in ms
+     *
      * @param {number} ms - milliseconds relative to start of video (relative to 0 ms)
      *  or in case of TV programs relative to start of the program (relative to source.from ms)
      */
     seekTo: (ms: number) => void;
     /**
-     * Source to be passed to player.
-     *
-     * Depending on autoplay settings it should either start playing
-     * immediately or just be loaded by player and stay paused.
+     * Send this source to player. And either start playing it immediately if `source.autoplay` is true
+     * or just load it and keep it paused and ready to play if `source.autoplay` is false.
+     * If source is `null`, stop and close the player (this is the same as if `this.stop()` was called.)
      */
-    setSource: (source: InputSource | null) => void;
+    setSource: (source: CommonSource | null) => void;
     /**
-     * volume in [0,1]
+     * Set volume
+     *
+     * @param {number} volume value in [0,1]
      */
     setVolume?: (volume: number) => void;
+    /**
+     * Mute the player volume
+     */
     mute?: () => void;
     /**
-     * restore volume to previous value
+     * Unmute the player volume and restore it to the save level that was before it has been muted
      */
     unmute?: () => void;
+    /**
+     * Sets native IMA ad URL which is then loaded and played on RN side
+     */
+    setNativeImaAdUrl?: (url: string) => void;
+    /**
+     * Try to load and play native IMA ad using provided URL
+     */
+    playNativeImaAd?: (url: string) => Promise<void>;
+    /**
+     * Get URL of native IMA ad which is currently playing
+     */
+    getNativeImaAdUrl?: () => string | null;
+    lastQuality?: number | null;
 }
 
 /**
@@ -1903,6 +2249,57 @@ export declare type PlayerProviderProps = {
     playerWrapperId?: string;
 };
 
+/**
+ * TODO same name as core-js entity, not convenient
+ * @public
+ */
+export declare type PlayerSource = VodTivioSourceInterface | VodExternalSourceInterface | ChannelSourceInterface | VirtualChannelSourceInterface;
+
+/**
+ * Use this interface only for inheritance. Otherwise use {@link PlayerSource}
+ * @public
+ */
+export declare interface PlayerSourceInterface<T extends NonAdSourceType = NonAdSourceType> extends CommonSourceInterface<T> {
+    adSegment: AdSegment | null;
+    consumedAds: ConsumedAds;
+    currentMarker: any | null;
+    markers: any[];
+    setMarkers(markers: any[]): void;
+    isMarkersLoaded: boolean;
+    setOutroMarker(marker: any): void;
+    durationMs: number;
+    setDurationMs(ms: number): void;
+    reset(): void;
+    cutout: Cutout | null;
+    destroy(): void;
+    seekTo(ms: number): void;
+    adMonetization: any;
+    setAdMonetization(monetization: any): void;
+    setInitialTime(ms: number): void;
+    setContinueFromPosition(ms: ContinuePosition): void;
+    isLive: boolean;
+    sourcePlayMode?: SourcePlayMode;
+    language?: LangCode | null;
+    availableLanguages?: LangCode[] | null;
+    startOrResumeReactions(): void;
+    pauseReactions(): void;
+    correctStartPosition(): Promise<void | null>;
+    setCanSeek(canSeek: boolean): void;
+    originalOptions: Record<string, any>;
+}
+
+/**
+ * @public
+ */
+export declare interface PlayerSourceParams<T extends NonAdSourceType = NonAdSourceType> extends CommonSourceParams<T> {
+    originalOptions?: Record<string, any>;
+    continuePositionMs?: ContinuePosition;
+    poster?: string | null;
+    language?: LangCode | null;
+    availableLanguages?: LangCode[] | null;
+    sourcePlayMode: SourcePlayMode;
+}
+
 /**
  * @public
  */
@@ -1911,7 +2308,7 @@ export declare type PlayerState = 'idle' | 'playing' | 'paused';
 /**
  * @public
  */
-export declare type PlayerWrapper = {
+export declare interface PlayerWrapper {
     /**
      * Report that playback of video has finished
      */
@@ -1927,7 +2324,7 @@ export declare type PlayerWrapper = {
     /**
      * Send source to Tivio
      */
-    onSourceChanged: (source: InputSource | null) => void;
+    onSourceChanged: (source: PlayerSource | null) => void;
     /**
      * Report that video failed to load (never started playing)
      */
@@ -1947,13 +2344,8 @@ export declare type PlayerWrapper = {
     /**
      * Currently playing source
      */
-    source: InputSource | null;
-    events: {
-        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;
-        removeAllListeners: () => void;
-    };
+    source: PlayerSource | null;
+    events: EmitterInterface;
     /**
      * Register a low level player that implements player methods, like play video, change volume, etc.
      */
@@ -1962,11 +2354,11 @@ export declare type PlayerWrapper = {
      * duration of current source in ms (both setter and getter)
      */
     durationMs: number | null;
-    isPlaybackStarted: boolean;
+    isPlaybackStarted?: boolean;
     isPaused: boolean;
     isPlaying: boolean;
     isIdle: boolean;
-    error: Error | null;
+    error: PlayerError | null;
     /**
      * Replay the video that finished playback
      */
@@ -1987,7 +2379,7 @@ export declare type PlayerWrapper = {
     changeVolumeBy: (volume: number) => void;
     setMuted: (muted: boolean) => void;
     toggleMuted: () => void;
-};
+}
 
 /**
  * @public
@@ -2067,6 +2459,10 @@ export declare type Purchase = {
      * Timestamp of the purchase creation in milliseconds.
      */
     created: number | null;
+    /**
+     * Email of the user who created the purchase manually.
+     */
+    createdBy?: string;
     expirationDate: Date | null;
     id: string;
     isExpired: boolean;
@@ -2097,7 +2493,8 @@ export declare enum PurchaseDocumentGateway {
     'qerko' = "qerko",
     'oktagon' = "oktagon",
     'voucher' = "voucher",
-    'comgate' = "comgate"
+    'comgate' = "comgate",
+    'tivio' = "tivio"
 }
 
 /**
@@ -2483,6 +2880,35 @@ export declare enum RowComponent {
     BANNER = "BANNER"
 }
 
+declare enum RowFilterCollection {
+    VIDEOS = "videos",
+    /**
+     * This is not real collection path. Path always should be ${organizationId}/tags
+     */
+    TAGS = "tags",
+    TV_CHANNELS = "tvChannels"
+}
+
+/**
+ * RowFilterField that is used in @tivio/firebase needs to be retyped here.
+ * @public
+ */
+export declare interface RowFilterField {
+    collection: RowFilterCollection;
+    limit?: number;
+    orderBy: {
+        fieldPath: RowOrderByFieldPath;
+        directionStr: OrderByDirection;
+    };
+    where: RowFilterWhereField[];
+}
+
+declare interface RowFilterWhereField {
+    fieldPath: RowWhereFilterFieldPath;
+    opStr: WhereFilterOp;
+    value: any;
+}
+
 /**
  * @public
  */
@@ -2528,6 +2954,15 @@ export declare type RowItemsSubscription = (rowId: string, cb: (error: Error | n
     hasNextPage: boolean;
 } | null, fetchMore: null | ((count?: number) => void), isLoading: boolean) => void, limit?: number) => Disposer_2;
 
+/**
+ * RowOrderByFieldPath that is used in @tivio/firebase needs to be retyped here.
+ * @public
+ */
+export declare enum RowOrderByFieldPath {
+    CREATED = "created",
+    DEFAULT_NAME = "defaultName"
+}
+
 /**
  * @private
  */
@@ -2536,6 +2971,15 @@ export declare interface RowStandard extends RowBase {
     itemComponent: RowItemComponent;
 }
 
+export declare enum RowWhereFilterFieldPath {
+    CREATED = "created",
+    TAGS = "tags",
+    TAG_TYPE_REF = "tagTypeRef",
+    TYPE = "type",
+    CONTENT_TYPE = "contentType",
+    CHANNEL_KEY = "channelKey"
+}
+
 /**
  * @public
  */
@@ -2555,10 +2999,12 @@ export declare type Scale = '@1' | '@2' | '@3';
  */
 declare interface Screen_2 {
     id: string;
-    name: string;
-    description?: string;
+    name: string | null;
+    description?: string | null;
     assets: Assets;
     rows: Row[];
+    type?: ScreenType;
+    filter?: RowFilterField | null;
 }
 export { Screen_2 as Screen }
 
@@ -2597,6 +3043,12 @@ export declare type ScreenRowType = 'filter' | 'custom' | 'continueToWatch' | 'f
  */
 export declare type ScreenSubscription = (screenId: string, cb: (error: Error | null, data: Screen_2 | null) => void) => Disposer_2;
 
+export declare enum ScreenType {
+    DEFAULT = "default",
+    GRID = "grid",
+    EMBED = "embed"
+}
+
 /**
  * Config of sdk-react. Contains all properties that can be passed via TivioProvider.
  * Consists of TivioConfig's properties + "sdk only" properties, that are used only in sdk, not in bundle.
@@ -2620,6 +3072,7 @@ export declare type SdkReactConfig = Omit<TivioConfig, 'language'> & {
 
 /**
  * @public
+ * @deprecated sections are no longer used.
  */
 export declare interface Section {
     id: string;
@@ -2662,7 +3115,7 @@ export declare const showGdprConsentPreferences: () => Promise<void>;
 /**
  * @public
  */
-export declare type Source = TvProgramSource | TivioVodSource | AdSource_2 | OtherSource | LiveTvChannelSource;
+export declare type Source = TvProgramSource | TivioVodSource | AdSource | OtherSource | LiveTvChannelSource;
 
 /**
  * @public
@@ -2683,6 +3136,37 @@ export declare type SourceBase = {
     uri: string;
 };
 
+/**
+ * Used to instantiate types of corresponding interfaces (children of {@link PlayerSourceInterface}).
+ * @public
+ */
+export declare type SourceParams = VodTivioSourceParams | VodExternalSourceParams | ChannelSourceParams | VirtualChannelSourceParams;
+
+/**
+ * Based on this value player will change how the source is played. This, for example, affects whether source:
+ *  - will be seekable or not
+ *  - duration will be dynamically updated as time goes on
+ *  - live button will be shown in ui
+ */
+export declare enum SourcePlayMode {
+    ON_DEMAND = "ON_DEMAND",
+    LIVE = "LIVE",
+    /**
+     * ON_DEMAND and LIVE at the same time.
+     */
+    HYBRID = "HYBRID"
+}
+
+/**
+ * @public
+ */
+export declare enum SourceType {
+    ADVERTISEMENT = "ad",
+    CHANNEL = "channel",
+    VOD_TIVIO = "vod_tivio",
+    VOD_EXTERNAL = "vod_external"
+}
+
 /**
  * @public
  */
@@ -2726,6 +3210,8 @@ export declare type SubscribeToItemsInRow = (rowId: string, cb: (error: Error |
  */
 export declare type SubscribeToItemsInRowOptions = Partial<{
     fetchTags: boolean;
+    orderBy?: OrderBy<'defaultName' | DefaultOrderByField>[];
+    where?: WhereFilter[];
 }> & PaginationOptions;
 
 /**
@@ -2746,11 +3232,8 @@ export declare type SubscribeToTaggedVideos = (tagIds: string[], cb: (error: Err
 /**
  * @public
  */
-export declare type SubscribeToTaggedVideosOptions = SubscribeToItemsInRowOptions & {
-    orderBy?: (Omit<OrderBy, 'field'> & {
-        field: TaggedVideosOrderByField;
-    })[];
-    where?: WhereFilter[];
+export declare type SubscribeToTaggedVideosOptions = Omit<SubscribeToItemsInRowOptions, 'orderBy'> & {
+    orderBy?: OrderBy<TaggedVideosOrderByField>[];
 };
 
 declare type SubscriptionInfo = {
@@ -2827,6 +3310,7 @@ export declare type TileOptions = {
          */
         fontSize: number;
     };
+    color?: string;
 };
 
 /**
@@ -2960,7 +3444,7 @@ export declare type TivioComponents = {
         onEnded?: () => any;
     }>;
     TvApp: React_2.ComponentType<TvAppProps>;
-    FeatureSupportCheck: React_2.ComponentType<{}>;
+    FeatureSupportCheck: React_2.ComponentType;
     CustomerScreen: React_2.ComponentType<{
         screenId: string;
     }>;
@@ -2968,6 +3452,7 @@ export declare type TivioComponents = {
         tagId: string;
         onError?: (error: Error) => void;
     }>;
+    WebGridScreen: React_2.ComponentType<WebGridScreenProps>;
     WebSearchScreen: React_2.ComponentType<{
         searchQuery?: string;
     }>;
@@ -2975,6 +3460,8 @@ export declare type TivioComponents = {
     WebTile: React_2.ComponentType<{
         item?: ItemsInRow;
     } & TilePropsPartial>;
+    ChannelContext: React_2.Context<TvChannel | undefined>;
+    ContentSortPicker: React_2.ComponentType<ContentSortPickerProps>;
 };
 
 /**
@@ -3061,9 +3548,9 @@ export declare type TivioGetters = {
  */
 export declare type TivioHooks = {
     useAd: () => [(AdExternal | null)];
-    useAdSegment: () => AdSegment | null;
+    useAdSegment: () => AdSegment_2 | null;
     useCancelSubscription: UseCancelSubscription;
-    useItemsInRow: (rowId: string, options: PaginationOptions) => {
+    useItemsInRow: (rowId?: string, options?: PaginationOptions) => {
         pagination: PaginationInterface<ItemsInRow> | null;
         error: Error | null;
     };
@@ -3079,20 +3566,19 @@ export declare type TivioHooks = {
         pagination: PaginationInterface<Row> | null;
         error: Error | null;
     };
-    useTaggedVideos: (tagIds: string[], options: SubscribeToItemsInRowOptions) => {
+    useTag: (tagId: string) => {
+        tag: Tag | null;
+    };
+    useTaggedVideos: (tagIds: string[], options: SubscribeToTaggedVideosOptions) => {
         pagination: PaginationInterface<Video> | null;
         error: Error | null;
     };
     useSearch: UseSearch;
-    useVideo: (videoId: string) => {
+    useVideo: (videoId?: string) => {
         data: Video | null;
         error: string | null;
     };
     useVoucher: (voucherId: string) => any;
-    useWatchWithoutAdsOffer: () => {
-        canPurchaseWatchWithoutAds: boolean;
-        showPurchaseDialog: () => void;
-    };
     useApplyInviteCode: () => {
         applyInviteCodeResult?: boolean;
         loading: boolean;
@@ -3101,6 +3587,7 @@ export declare type TivioHooks = {
         inviteCodeReset: () => void;
     };
     useChannelSource: UseChannelSource;
+    useTvChannel: UseTvChannel;
 };
 
 /**
@@ -3128,6 +3615,7 @@ export declare type TivioInternalComponents = {
     UserProfilesOverlay: React_2.ComponentType<{
         onClose: (selectedProfileId: string) => void;
     }>;
+    Banner: React_2.ComponentType<BannerPropsPartial>;
 };
 
 /**
@@ -3142,6 +3630,19 @@ export declare type TivioInternalHooks = {
     usePurchasesWithVideos: () => {
         purchases: Purchase[];
     };
+    useEpisodes: (seriesTagId: string | null | undefined, seasonNumber: number | null, options: UseEpisodesQueryOptions) => UseEpisodesResult;
+    useVideosInScreen: (filters: RowFilterField) => {
+        pagination: PaginationInterface<Video> | null;
+        error: Error | null;
+    };
+    useSimilars: () => {
+        getSimilars: ({ videoId, similarsQuery }: {
+            videoId: string;
+            similarsQuery?: RecommendationsQuery | undefined;
+        }) => Promise<void>;
+        pagination: PaginationInterface<Video>;
+        error: Error | null;
+    };
     useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean, videoId?: string) => {
         subscriptions: PurchasableMonetization[];
     };
@@ -3167,6 +3668,8 @@ export declare type TivioInternalHooks = {
         isSignedIn: boolean;
     };
     useOrganization: () => Organization | null;
+    useRow: UseRow;
+    useScreen: (screenId: string | null) => Screen_2 | null;
 };
 
 /**
@@ -3470,6 +3973,7 @@ export declare interface TvChannel extends RowItem {
     country?: string;
     filters: string[];
     logo?: string;
+    logoPendingOverlayWidth?: string;
     hls: string;
     dash: string;
     /**
@@ -3487,15 +3991,34 @@ export declare interface TvChannel extends RowItem {
     cover: string;
     isPlayable: boolean;
     url: string;
+    type?: TvChannelType;
 }
 
+export declare enum TvChannelType {
+    /**
+     * Classic live tv channel
+     */
+    CLASSIC = "CLASSIC",
+    /**
+     * "Virtual" tv channel constructed from separate videos
+     */
+    VIRTUAL = "VIRTUAL"
+}
+
+/**
+ * @public
+ */
+export declare type TvMode = 'startover' | 'timeshift';
+
 export declare interface TvProgram {
+    id: string;
     from: Date | null;
     to: Date | null;
     name: string;
     description: string;
     url: string;
     image: string;
+    landscape?: string | null;
     video: Video | null;
 }
 
@@ -3528,6 +4051,13 @@ export declare type TvProgramSource = SourceBase & StartAndContinuePosition & {
     streamStart: Date;
 };
 
+export declare enum TvStreamType {
+    STARTOVER = "startover",
+    TIMESHIFT = "timeshift",
+    LIVE = "live",
+    ALL = "all"
+}
+
 /**
  * @public
  */
@@ -3571,11 +4101,6 @@ export declare function useApplyInviteCode(): {
     inviteCodeReset: () => void;
 };
 
-/**
- * @public
- */
-export declare const useBetOffer: () => BetOffer | null;
-
 /**
  * @public
  */
@@ -3601,20 +4126,25 @@ export declare interface UseCancelSubscriptionsResult {
 
 /**
  * @public
+ * @deprecated No longer used. Pass channel path to 'WebPlayer.source' prop instead. Path can be obtained with useTvChannel hook.
  */
 export declare type UseChannelSource = (tvChannelId: string) => {
-    source: ChannelSourcePojo | VirtualChannelSourcePojo | null;
+    source: string;
     error: Error | null;
 };
 
 /**
  * Use channel source
  * @param tvChannelId
+ * @deprecated No longer used. Pass channel path to 'WebPlayer.source' prop instead. Path can be obtained with useTvChannel hook.
  * @public
  */
 export declare const useChannelSource: (tvChannelId: string) => {
-    source: ChannelSourcePojo | VirtualChannelSourcePojo | null;
+    source: string;
     error: Error | null;
+} | {
+    error: null;
+    source: null;
 };
 
 /**
@@ -3622,6 +4152,37 @@ export declare const useChannelSource: (tvChannelId: string) => {
  */
 export declare const useCurrentMarker: () => Marker | null;
 
+/**
+ * @public
+ */
+export declare type UseEpisodesQueryOptions = {
+    limit: number;
+    fetchTags?: boolean;
+    orderBy?: SubscribeToTaggedVideosOptions['orderBy'];
+};
+
+/**
+ * @public
+ */
+export declare type UseEpisodesResult = {
+    /**
+     * Episodes of concrete season of series defined by seriesTagId.
+     */
+    episodes: Video[];
+    /**
+     * Function to fetch more episodes
+     */
+    fetchMoreEpisodes?: () => void;
+    /**
+     * True when fetching data
+     */
+    episodesLoading: boolean;
+    /**
+     * True when there are more episodes to fetch
+     */
+    hasMoreEpisodes: boolean;
+};
+
 /**
  * @public
  */
@@ -3647,7 +4208,7 @@ export declare const useIsMonetizationPurchased: () => {
  * @param options - subscription options
  * @public
  */
-export declare const useItemsInRow: (rowId: string, options?: SubscribeToItemsInRowOptions) => {
+export declare const useItemsInRow: (rowId?: string, options?: SubscribeToItemsInRowOptions) => {
     pagination: PaginationInterface<ItemsInRow> | null;
     error: Error | null;
 };
@@ -3747,6 +4308,14 @@ export declare enum UserGroup {
     PREMIUM = "premium"
 }
 
+/**
+ * @public
+ */
+export declare type UseRow = (rowId: string | null) => {
+    row: Row | null;
+    error: Error | null;
+};
+
 /**
  * @public
  */
@@ -3821,7 +4390,7 @@ export declare const useSeekState: () => boolean | null;
  * @param options - subscription options
  * @public
  */
-export declare const useTaggedVideos: (tagIds: string[], options?: SubscribeToItemsInRowOptions) => {
+export declare const useTaggedVideos: (tagIds: string[], options?: SubscribeToTaggedVideosOptions) => {
     pagination: PaginationInterface<Video> | null;
     error: Error | null;
 };
@@ -3890,15 +4459,15 @@ export declare const useVoucher: (voucherId: string) => {
 /**
  * @public
  */
-export declare const useWatchWithoutAdsOffer: () => {
-    canPurchaseWatchWithoutAds: boolean;
-    showPurchaseDialog: () => void;
-};
+export declare const VAST_PROVIDERS: VastProvidersItem[];
 
 /**
  * @public
+ * null - classic VAST
+ * VPAID - VAST with VPAID extension
+ * others...
  */
-export declare const VAST_PROVIDERS: VastProvidersItem[];
+export declare type VastApiFramework = string | 'VPAID' | null;
 
 /**
  * @public
@@ -3963,6 +4532,12 @@ export declare interface Video extends RowItem {
     }): Promise<GetSourceUrlResponse & {
         language?: LangCode;
     }>;
+    getSeekingMatrixPreviewByTime(timeMs: number, offsetIndex: number): {
+        url: string;
+        x: number;
+        y: number;
+        timeMs: number;
+    } | null;
     purchasableMonetization: any | null;
     transaction: PurchasableMonetization | undefined;
     subscriptions: PurchasableMonetization[];
@@ -4105,42 +4680,76 @@ export declare interface ViewCountItem {
 /**
  * @public
  */
-export declare interface VirtualChannelSourcePojo extends Omit<ChannelSourcePojo, 'type'> {
-    type: 'VirtualChannelSource';
-    epg: TvProgram[];
+export declare interface VirtualChannelSourceInterface extends ChannelSourceInterface {
+    tvChannelType: TvChannelType.VIRTUAL;
+    program?: TvProgram | null;
+    video?: Video | null;
+    isPlayingBySchedule: boolean;
+    clone(params?: Partial<VirtualChannelSourceParams>): VirtualChannelSourceInterface;
+    initializeNext(): Promise<void>;
 }
 
 /**
  * @public
  */
-export declare type VodExternalSource = {
-    new (url: string, monetizationId: string, name: string, description: string, originalOptions: Record<string, any>): VodTivioSource;
-    type: 'vod_external';
-    description: string;
-    name: string;
-    url: string;
-};
+export declare interface VirtualChannelSourceParams extends ChannelSourceParams {
+    tvChannelType: TvChannelType.VIRTUAL;
+    currentProgram?: TvProgram | null;
+}
 
 /**
  * @public
  */
-export declare type VodTivioSource = {
-    new (url: string, videoId: string, name: string, description: string, adMonetizationId?: string): VodTivioSource;
-    type: 'vod_tivio';
-    description: string;
-    name: string;
-    url: string;
-};
+export declare interface VodExternalSourceInterface extends PlayerSourceInterface<SourceType.VOD_EXTERNAL> {
+    monetizationId?: string;
+    originalOptions: Record<string, any>;
+    poster: string | null;
+}
 
-declare interface VodTivioSourcePojo {
-    type: 'VodTivioSource';
-    description: string;
-    path: string;
-    name: string;
-    url: string;
-    poster?: string;
+/**
+ * @public
+ */
+export declare interface VodExternalSourceParams extends PlayerSourceParams<SourceType.VOD_EXTERNAL> {
+    monetizationId?: string;
+}
+
+/**
+ * @public
+ */
+export declare interface VodTivioSourceInterface extends PlayerSourceInterface<SourceType.VOD_TIVIO> {
+    /**
+     * e.g. 259ud0fgdf4
+     */
     adMonetizationId?: string;
+    /**
+     * e.g. videos/1532543
+     */
+    videoPath: string;
+    poster: string | null;
+    /**
+     * Position to continue playing from in milliseconds
+     */
+    continuePositionMs?: ContinuePosition;
+    /**
+     * Drm configuration
+     */
+    drm?: Drm;
+    watermark: Watermark | null;
+    canWatchOnDevice: boolean;
+    isAvailable: boolean;
     availability: VideoAvailability | null;
+    video: Video;
+    clone: (params?: Partial<VodTivioSourceParams>) => VodTivioSourceInterface;
+}
+
+/**
+ * @public
+ */
+export declare interface VodTivioSourceParams extends PlayerSourceParams<SourceType.VOD_TIVIO> {
+    videoPath: string;
+    adMonetizationId?: string;
+    language?: LangCode;
+    drm?: Drm;
 }
 
 /**
@@ -4163,12 +4772,31 @@ export declare interface WarningConfirmationOverlayPayload extends ConfirmationO
     closeButtonText?: string;
 }
 
+/**
+ * @public
+ */
+export declare interface Watermark {
+    caption: string;
+    size: 'large' | 'medium';
+}
+
+/**
+ * @public
+ */
+export declare type WebGridScreenProps = {
+    screen?: Screen_2;
+    seriesId?: string;
+    season?: number;
+    rowId?: string;
+    videoId?: string;
+};
+
 /**
  * @public
  */
 export declare interface WebPlayerProps {
     id: string;
-    source?: VodTivioSourcePojo | ChannelSourcePojo | VirtualChannelSourcePojo | VideoPath | null;
+    source?: SourceParams | VideoPath | ChannelPath | null;
     onEnded?: () => any;
     /**
      * If this function is specified, then "Back" button is shown in top right corner.
@@ -4215,6 +4843,41 @@ export declare interface WebPlayerProps {
      * @deprecated this callback is never called. Will be removed in @tivio/sdk-react version 4
      */
     onPlayerControllerCreated?: (playerController: any) => void;
+    /**
+     * If true, saving of watch position won't be performed.
+     */
+    doNotSaveWatchPosition?: boolean;
+    /**
+     * If true, then is muted by default, but still be possible to unmute
+     */
+    isMutedByDefault?: boolean;
+    markerColor?: string;
+    showTvStreamType?: boolean;
+    showCookiesSettings?: boolean;
+    /**
+     * If false, then OSD is never shown.
+     * If true then OSD is shown based on condition resolved in HidableOsdContainer, e.g. on pause, on mouse move etc.
+     */
+    showOsd?: boolean;
+    /**
+     * If false, then buffering spinner is never shown.
+     * If true then buffering spinner is shown while buffering.
+     */
+    showBufferingSpinner?: boolean;
+    /**
+     * If true, then check adblock and show warning if it's turned on.
+     * If false, adblock warning is never shown.
+     */
+    checkAdBlock?: boolean;
+    /**
+     * Player video can be scaled. Used in WebVideoDetailBanner to "hide" black stripes on video.
+     * Should be positive number.
+     */
+    scale?: number;
+    /**
+     * If true, it does not play the next video when the current video reaches the end.
+     */
+    disablePlayNext?: boolean;
 }
 
 /**
@@ -4255,6 +4918,7 @@ declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-cont
 
 /**
  * @public
+ * @deprecated this widget structure is no longer used.
  */
 export declare type Widget = {
     id: string;
@@ -4269,6 +4933,6 @@ export declare type Widget = {
 /**
  * @public
  */
-export declare function withPlayerContext(id: string): <P extends JSX.IntrinsicAttributes>(WrappedComponent: React_2.ComponentType<P>) => (props: P) => JSX.Element;
+export declare function withPlayerContext(id: string): <P extends JSX.IntrinsicAttributes>(WrappedComponent: React_2.ComponentType<P>) => (props: P) => React_2.JSX.Element;
 
 export { }