@tivio/sdk-react 3.7.0 → 4.0.0

package/dist/sdk-react.d.ts

@@ -106,6 +106,14 @@ export declare enum ALGOLIA_INDEX_NAME {
     USERS = "users"
 }
 
+/**
+ * @public
+ */
+export declare type ArrisDeviceInfo = {
+    type: 'arris';
+    model?: 'VIP1003' | 'VIP1113' | 'VIP5305';
+};
+
 /**
  * @public
  */
@@ -202,39 +210,6 @@ export declare type BannerProps = {
  */
 export declare type BannerPropsPartial = Partial<BannerProps>;
 
-/**
- * @public
- */
-export declare type BasicTivioBundle = {
-    components: TivioComponents;
-    getters: TivioGetters;
-    auth: TivioAuth;
-    hooks: TivioHooks;
-    sources: TivioSources;
-    subscriptions: TivioSubscriptions;
-    purchaseVideoWithQerko: (videoId: string, monetizationId: string, voucher?: {
-        expirationDate: Date;
-    }) => Promise<QerkoPaymentInfo>;
-    purchaseSubscriptionWithQerko: (monetizationId: string, voucher?: {
-        expirationDate: Date;
-    }) => Promise<QerkoPaymentInfo>;
-    cancelSubscriptionWithQerko: (subscriptionId: string) => Promise<QerkoCancellationInfo>;
-    /**
-     * Set tivio language.
-     * @param language
-     */
-    setLanguage: (language: LangCode) => void;
-    setUser: (userId: string | null, userPayload?: UserPayload) => Promise<void>;
-    showConsentPreferences: () => void;
-    /**
-     * Contains hooks and providers for internal usages.
-     * They used in our apps, e.g. web, or in sdk-react (e.g. some sdk hooks are just wrappers for core-react-dom hooks)
-     * TODO should not be the part of public API
-     */
-    internal: TivioInternalBundle;
-    destroy: () => Promise<void>;
-};
-
 /**
  * @public
  */
@@ -268,7 +243,7 @@ export declare type ButtonOptions = {
 /**
  * @public
  */
-export declare type Callback = () => void;
+export declare type Callback<T = any> = (arg?: T) => void;
 
 /**
  * @public
@@ -281,11 +256,6 @@ export declare interface Channel {
     recentVideos: Video[];
 }
 
-/**
- * @public
- */
-export declare const ChannelsContext: React_2.Context<DataState<Channel>>;
-
 /**
  * @public
  */
@@ -323,6 +293,11 @@ export declare interface ChannelSourcePojo {
  */
 export declare type Chapter = any;
 
+/**
+ * @public
+ */
+export declare type CmpConfig = 'default' | 'debug' | 'none';
+
 /**
  * TODO it's the same as Customizations, not?
  * @internal
@@ -341,16 +316,10 @@ export declare type Components = {
 };
 
 /**
+ * Just another alias. Reexported for backward compatibility.
  * @public
  */
-export declare type Config = Pick<InternalConfig, 'bundleUrlOverride' | 'currency' | 'disableUnmounting' | 'capabilitiesOptions' | 'enable' | 'enableSentry' | 'ErrorComponent' | 'language' | 'LoaderComponent' | 'logger' | 'secret' | 'verbose' | 'forceCloudFnResolver'> & {
-    deviceCapabilities: PlayerCapability[] | 'auto';
-    /**
-     * @private
-     * Run HTML, CSS and JS feature support check
-     */
-    runFeatureSupportCheck?: boolean;
-};
+export declare type Config = SdkReactConfig;
 
 /**
  * @public
@@ -469,13 +438,6 @@ export declare interface CustomThemeOptions {
     size: (size: number) => number;
 }
 
-declare interface DataState<T> {
-    data: {
-        [key: string]: HookData<T>;
-    };
-    setData: (key: string, data: HookData<T>) => void;
-}
-
 /**
  * @public
  */
@@ -498,6 +460,11 @@ export declare type DetailedPrice = {
     frequency?: MONETIZATION_FREQUENCY;
 };
 
+/**
+ * @public
+ */
+export declare type DeviceInfo = ArrisDeviceInfo | WebosDeviceInfo | TizenDeviceInfo;
+
 /**
  * @public
  */
@@ -571,12 +538,6 @@ export declare interface GenericOnCallError {
  */
 export declare const getPubSub: () => PubSub;
 
-declare interface HookData<T> {
-    data: PaginationData<T> | null;
-    error: Error | null;
-    isLoading: boolean;
-}
-
 /**
  * @public
  */
@@ -651,46 +612,23 @@ export declare type InputSource = AdSource | ChannelSource | VodTivioSource | Vo
 /**
  * @public
  */
-export declare type InternalConfig = {
-    /**
-     * @private URL of remote code bundle to be fetched directly (without using resolver)
-     */
-    bundleUrlOverride?: string;
-    /**
-     * Tells Tivio which technologies/protocols etc. is the device capable to play.
-     * If not provided, Tivio will try to guess it (based on the browser).
-     */
-    deviceCapabilities: PlayerCapability[];
-    /**
-     * Additional options for deviceCapabilities
-     */
-    capabilitiesOptions?: {
-        /**
-         * Should the player prefer HTTP sources instead HTTPs if they are available.
-         * This can be used on platforms that support mixed content but do not support
-         * specific HTTPS certificates. (e.g. certificates from Letsencrypt not supported on LG TVs)
-         */
-        preferHttp?: boolean;
-    };
-    secret: string | null;
-    language?: LangCode;
-    verbose?: boolean;
-    currency: Currency;
-    disableUnmounting?: boolean;
-    enable?: boolean;
-    enableSentry?: boolean;
-    ErrorComponent?: ComponentType<{
-        error: string | null;
-    }>;
+export declare type InternalConfig = SdkReactConfig & {
     fetchPackage: FetchPackage;
-    LoaderComponent?: ComponentType;
-    logger?: Logger | null;
     pubSub: PubSub;
     /**
      * @private URL of resolver. Resolver is a script used to fetch remove code bundle
      */
     resolverUrl: string;
     sdkVersion: string;
+    /**
+     * @private URL of remote code bundle to be fetched directly (without using resolver)
+     */
+    bundleUrlOverride?: string;
+    /**
+     * @private
+     * Run HTML, CSS and JS feature support check
+     */
+    runFeatureSupportCheck?: boolean;
     /**
      * @private
      */
@@ -851,12 +789,6 @@ declare type OrderByDirection = 'desc' | 'asc';
 export declare interface Organization {
 }
 
-declare type PaginationData<T> = {
-    items: T[];
-    hasNextPage: boolean;
-    fetchMore: Function;
-};
-
 /**
  * @public
  */
@@ -893,6 +825,54 @@ export declare interface PlayerCapability {
     protocol: 'dash' | 'hls' | 'mp4';
 }
 
+/**
+ * @public
+ */
+export declare type PlayerConfig = {
+    /**
+     * Some devices do not seek exactly
+     *
+     * e.g. on Arris if we request seek to position P, in reality it will seek to P -+5s
+     * e.g. on Arris if we request play from position P, in reality it will play from P -+5s
+     * (on Arris the error margin varies according to video format)
+     */
+    acceptablePositionAnomalyMs?: number;
+    /**
+     * Stream delay config
+     *
+     * IP TV apps have TV program / TV channel streams delayed relative to the original
+     * video source. Therefore stream markers taken from the original video source
+     * are delayed relative to the TV stream seen by end users of the IP TV app.
+     *
+     * This delay must be corrected.
+     */
+    streamDelayConfig?: {
+        /**
+         * ID of the delay config
+         */
+        id: string;
+    };
+    ui?: {
+        /**
+         * ID of a DOM element inside which Tivio should display its player-related UI
+         * such as ad buttons. This DOM element is an anchor point for Tivio UI. Preferably
+         * it should be a <div/> element styled to cover the whole area of the video player
+         * and it should be positioned to be on top the existing player UI (e.g. via z-index).
+         */
+        domAnchorId: string | null;
+    };
+    protocols?: {
+        mp4?: {
+            /**
+             * Set to false if player does not support MP4 files that require full file download
+             * (i.e. they do not support progressive MP4 download and therefore the whole file
+             * must be downloaded before playback can start)
+             */
+            fullFileDownloadSupport?: boolean;
+        };
+    };
+};
+
 /**
  * @public
  */
@@ -1159,7 +1139,6 @@ export declare interface QerkoTransaction {
 export declare type RemoteBundleState = {
     config: InternalConfig;
     error: string | null;
-    settings: Settings;
     state: 'loading' | 'error' | 'ready';
 } & Nullable<TivioBundle>;
 
@@ -1323,6 +1302,25 @@ 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;
 
+/**
+ * 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.
+ *
+ * @public
+ */
+export declare type SdkReactConfig = Omit<TivioConfig, 'deviceCapabilities' | 'language'> & {
+    disableUnmounting?: boolean;
+    enable?: boolean;
+    enableSentry?: boolean;
+    ErrorComponent?: ComponentType<{
+        error: string | null;
+    }>;
+    LoaderComponent?: ComponentType;
+    logger?: Logger | null;
+    deviceCapabilities: PlayerCapability[] | 'auto';
+    language?: LangCode;
+};
+
 /**
  * @public
  */
@@ -1333,21 +1331,6 @@ export declare interface Section {
     videos: Video[];
 }
 
-/**
- * @public
- */
-export declare const SectionsContext: React_2.Context<DataState<Section>>;
-
-/**
- * @public
- */
-export declare type Settings = {
-    /**
-     * @deprecated TIV-994 in favour of setUser from libs/sdk-react/src/services/login.ts
-     */
-    setUser: (userId: string, userPayload: unknown) => Promise<void>;
-};
-
 /**
  * Used for entities, that can be global (e.g. asset presets, tag types).
  * Non-global is stored under organizations (in sub-collection), and shown for organization's users and super-admin.
@@ -1524,10 +1507,6 @@ export declare type TilePropsPartial = Partial<TileProps>;
  * @public
  */
 export declare interface TivioAuth {
-    changePassword: (newPassword: string) => Promise<void>;
-    changeUserPhoto(file: any): Promise<void>;
-    removeUserPhoto(): Promise<void>;
-    getPurchasedVodsWithInitializedVideos: () => Promise<Purchase[]>;
     /**
      * @param email
      * @param password
@@ -1539,21 +1518,17 @@ export declare interface TivioAuth {
      * @param password
      */
     signInWithEmailAndPassword: (email: string, password: string) => Promise<string | null>;
-    initializeUser: () => Promise<void>;
     signOut: () => Promise<void>;
     /**
      * Used for reset forgotten password by user
      */
     resetPassword: (email: string) => Promise<void>;
-    createFreePurchase: (monetizationId: string) => Promise<void>;
 }
 
 /**
  * @public
  */
-export declare type TivioBundle = BasicTivioBundle & {
-    init: (config: Config) => void | Promise<void>;
-};
+export declare type TivioBundle = TivioReactBundle;
 
 /**
  * @public
@@ -1569,10 +1544,6 @@ export declare type TivioComponents = {
     Markers: React_2.ReactNode;
     PlayerDataContext: React_2.ReactNode;
     Provider: React_2.ComponentType<RemoteProviderProps>;
-    /**
-     * @deprecated will be removed in in @tivio/sdk-react@4
-     */
-    VideoAdBanner: React_2.ReactNode;
     WebPlayer: React_2.ComponentType<WebPlayerProps>;
     Widget: React_2.ComponentType<TivioWidgetProps>;
     PlayerDataContextProvider: React_2.ComponentType<{
@@ -1607,6 +1578,44 @@ export declare type TivioComponents = {
     TvPlayer: React_2.ComponentType<WebPlayerProps>;
 };
 
+/**
+ * @public
+ */
+export declare interface TivioConfig {
+    /**
+     * Tells Tivio which technologies/protocols etc. is the device capable to play.
+     * If not provided, Tivio will try to guess it (based on the browser).
+     */
+    deviceCapabilities?: PlayerCapability[];
+    /**
+     * Additional options for deviceCapabilities
+     */
+    capabilitiesOptions?: {
+        /**
+         * Should the player prefer HTTP sources instead HTTPs if they are available.
+         * This can be used on platforms that support mixed content but do not support
+         * specific HTTPS certificates. (e.g. certificates from Letsencrypt not supported on LG TVs)
+         */
+        preferHttp?: boolean;
+    };
+    secret: string;
+    language: LangCode;
+    debug?: boolean;
+    verbose?: boolean;
+    firebaseApp?: any;
+    currency: Currency;
+    /**
+     * Configuration for GDPR consent collection (CMP)
+     */
+    cmp?: CmpConfig;
+    /**
+     * Device information - model, os, version, etc. This is useful for devices
+     * where this information cannot be reliably auto-detected.
+     */
+    deviceInfo?: DeviceInfo;
+    player?: PlayerConfig;
+}
+
 /**
  * @public
  */
@@ -1618,18 +1627,6 @@ export declare const TivioContext: React_2.Context<RemoteBundleState | null>;
 export declare type TivioGetters = {
     isTivioLoaded: (cb: (isLoaded: boolean) => void) => void;
     isSignedIn: () => boolean;
-    /**
-     * @deprecated is here only for backward compatibility
-     */
-    getExportedConfig: () => Promise<{
-        showMarkers: true;
-    }>;
-    /**
-     * Get channel by its id.
-     * @param channelId - channel id
-     * @returns {Promise<Channel | null>} channel or null if channel does not exists
-     */
-    getChannelById: (channelId: string) => Promise<Channel | null>;
     /**
      * Get (or create) player wrapper instance
      * @param opt - player getter options
@@ -1639,24 +1636,12 @@ export declare type TivioGetters = {
         playerWrapperId?: string;
     }) => any;
     getOrganizationSubscriptions: () => Promise<Monetization[] | undefined>;
-    /**
-     * Get section by its id.
-     * @param sectionId - section id
-     * @returns {Promise<{section: Section, channel: Channel} | null>} section and channel or null if channel or section does not exists
-     */
-    getSectionById: (sectionId: string) => Promise<Section | null>;
     /**
      * Get video by its id.
      * @param videoId - video id
      * @returns {Promise<Video | null>} video or null if video does not exists
      */
     getVideoById: (videoId: string) => Promise<Video | null>;
-    /**
-     * Get widget by its id.
-     * @param widgetId - widget id
-     * @returns {Promise<Widget | null>} widget or null if widget does not exists
-     */
-    getWidgetById: (widgetId: string) => Promise<Widget | null>;
     /**
      * Get player capabilities based on user's browser and OS as resolved by Tivio.
      * @returns PlayerCapability[]
@@ -1697,10 +1682,6 @@ export declare type TivioHooks = {
         error: string | null;
     };
     useVoucher: (voucherId: string) => any;
-    /**
-     * @deprecated will be removed in version
-     */
-    useLastVideoByWidgetId: (widgetId: string) => Video | null;
     useWatchWithoutAdsOffer: () => {
         canPurchaseWatchWithoutAds: boolean;
         showPurchaseDialog: () => void;
@@ -1795,10 +1776,44 @@ export declare type TivioProviderProps = {
     /**
      * This prop must be set only once and not change value afterwards
      */
-    conf: Config | undefined | null;
+    conf: SdkReactConfig | undefined | null;
     children: React_2.ReactNode;
 };
 
+/**
+ * @public
+ */
+export declare type TivioReactBundle = {
+    init: (config: TivioConfig) => void | Promise<void>;
+    components: TivioComponents;
+    getters: TivioGetters;
+    auth: TivioAuth;
+    hooks: TivioHooks;
+    sources: TivioSources;
+    subscriptions: TivioSubscriptions;
+    purchaseVideoWithQerko: (videoId: string, monetizationId: string, voucher?: {
+        expirationDate: Date;
+    }) => Promise<QerkoPaymentInfo>;
+    purchaseSubscriptionWithQerko: (monetizationId: string, voucher?: {
+        expirationDate: Date;
+    }) => Promise<QerkoPaymentInfo>;
+    cancelSubscriptionWithQerko: (subscriptionId: string) => Promise<QerkoCancellationInfo>;
+    /**
+     * Set tivio language.
+     * @param language
+     */
+    setLanguage: (language: LangCode) => void;
+    setUser: (userId: string | null, userPayload?: UserPayload) => Promise<void>;
+    showConsentPreferences: () => void;
+    /**
+     * Contains hooks and providers for internal usages.
+     * They used in our apps, e.g. web, or in sdk-react (e.g. some sdk hooks are just wrappers for core-react-dom hooks)
+     * TODO should not be the part of public API
+     */
+    internal: TivioInternalBundle;
+    destroy: () => Promise<void>;
+};
+
 /**
  * @public
  */
@@ -1814,61 +1829,12 @@ export declare type TivioSources = {
  */
 export declare type TivioSubscriptions = {
     subscribeToUser: (cb: (error: string | null, user: User | null) => void) => void;
-    /**
-     * Listen to widget changes.
-     * @param widgetId - widget id
-     * @param cb - callback on widget updates or on error
-     */
-    subscribeToWidget: (widgetId: string, cb: (error: Error | null, data: Widget | null, disposer?: Disposer_2) => void) => void;
-    /**
-     * Listen to channel changes.
-     * @param channelId - channel id
-     * @param cb - callback on channel updates or on error
-     */
-    subscribeToChannel: (channelId: string, cb: (error: Error | null, data: Channel | null) => void) => void;
-    /**
-     * Listen to section changes.
-     * @param sectionId - section id
-     * @param cb - callback on section updates or on error
-     */
-    subscribeToSection: (sectionId: string, cb: (error: Error | null, data: Section | null) => void) => void;
     /**
      * Listen to video changes.
      * @param videoId - video id
      * @param cb - callback on video updates or on error
      */
     subscribeToVideo: (videoId: string, cb: (error: Error | null, data: Video | null, disposer?: Disposer_2) => void) => void;
-    /**
-     * Listen to videos in section changes.
-     * @param sectionId - section id
-     * @param cb - callback on videos change or error
-     * @param limit - videos count
-     */
-    subscribeToVideosInSection: (sectionId: string, cb: (error: null | Error, data: null | {
-        videos: Video[];
-        hasNextPage: boolean;
-    }, fetchMore: null | ((count?: number) => void), isLoading: boolean) => void, limit?: number) => void;
-    /**
-     * Listen to section in channel changes
-     * @param channelId - channel id
-     * @param cb - callback on sections change or error
-     * @param limit - sections count
-     */
-    subscribeToSectionsInChannel: (channelId: string, cb: (error: null | Error, data: null | {
-        sections: Section[];
-        hasNextPage: boolean;
-    }, fetchMore: null | ((count?: number) => void), isLoading: boolean) => void, limit?: number) => void;
-    /**
-     * Listen to channels in widget changes
-     * @param widgetId - widget id
-     * @param cb - callback on channels change or error
-     * @param limit - channels count
-     */
-    subscribeToChannelsInWidget: (widgetId: string, cb: (error: null | Error, data: null | {
-        channels: Channel[];
-        hasNextPage: boolean;
-    }, fetchMore: null | ((count?: number) => void), isLoading: boolean) => void, limit?: number) => void;
-    subscribeToScreen: SubscribeToScreen;
     subscribeToItemsInRow: SubscribeToItemsInRow;
     subscribeToRowsInScreen: SubscribeToRowsInScreen;
     subscribeToTaggedVideos: SubscribeToTaggedVideos;
@@ -1927,6 +1893,15 @@ export declare interface TivioWidgetRef {
     });
 }
 
+/**
+ * @public
+ */
+export declare type TizenDeviceInfo = {
+    type: 'tizen';
+    model?: string;
+    osVersion?: string;
+};
+
 declare type TransactionInfo = {
     type: 'transaction';
     name: string;
@@ -2029,28 +2004,6 @@ export declare type UseCancelSubscription = (subscriptionId: string) => {
  */
 export declare const useCancelSubscription: UseCancelSubscription;
 
-/**
- * Use channel
- * @param channelId - channel id
- * @public
- */
-export declare const useChannel: (channelId: string) => {
-    error: string | null;
-    data: Channel | null;
-};
-
-/**
- * Use channels in widget
- * @param widgetId - widget id
- * @param [limit] - channels count, defaults to 10
- * @public
- */
-export declare const useChannelsInWidget: (widgetId: string, limit?: number) => {
-    error: Error | null;
-    data: PaginationData<Channel> | null;
-    isLoading: boolean;
-};
-
 /**
  * @public
  */
@@ -2064,13 +2017,6 @@ export declare type UseChannelSource = (tvChannelId: string) => {
  */
 export declare const useCurrentMarker: () => Marker | null;
 
-/**
- * @public
- */
-export declare const useFreePurchase: () => {
-    purchase: (monetizationId: string) => Promise<void>;
-};
-
 /**
  * @public
  */
@@ -2101,12 +2047,6 @@ export declare const useItemsInRow: (rowId: string, options?: SubscribeToItemsIn
     error: Error | null;
 };
 
-/**
- * @deprecated will be removed in v4
- * @public
- */
-export declare function useLastVideoByWidgetId(widgetId: string): Video | null;
-
 /**
  * @public
  */
@@ -2198,16 +2138,6 @@ export declare enum UserType {
     TIVIO_USER = "TIVIO_USER"
 }
 
-/**
- * @deprecated
- *
- * Use app screen
- * @param screenId - screen ID
- * @param options - subscribe to screen options
- * @public
- */
-export declare const useScreen: (screenId: string, options?: ScreenOptions | undefined) => never;
-
 /**
  * @public
  */
@@ -2239,28 +2169,6 @@ export declare type UseSearchOptions = PaginationOptions & Partial<{
  */
 export declare type UseSearchResult<T extends ALGOLIA_INDEX_NAME> = T extends ALGOLIA_INDEX_NAME.VIDEOS ? Video : T extends ALGOLIA_INDEX_NAME.TAGS ? Tag : T extends ALGOLIA_INDEX_NAME.TV_CHANNELS ? TvChannel : unknown;
 
-/**
- * Use section
- * @param sectionId - section id
- * @public
- */
-export declare const useSection: (sectionId: string) => {
-    error: string | null;
-    data: Section | null;
-};
-
-/**
- * Use section in channel
- * @param channelId - channel id
- * @param [limit] - sections count, defaults to 10
- * @public
- */
-export declare const useSectionsInChannel: (channelId: string, limit?: number) => {
-    error: Error | null;
-    data: PaginationData<Section> | null;
-    isLoading: boolean;
-};
-
 /**
  * @public
  */
@@ -2320,18 +2228,6 @@ export declare const useVideo: (videoId?: string | undefined) => {
     error: string | null;
 };
 
-/**
- * Use videos in section
- * @param sectionId - section id
- * @param [limit] - videos count, defaults to 10
- * @public
- */
-export declare const useVideosInSection: (sectionId?: string | undefined, limit?: number) => {
-    error: Error | null;
-    data: PaginationData<Video> | null;
-    isLoading: boolean;
-};
-
 /**
  * @public
  */
@@ -2357,16 +2253,6 @@ export declare const useWatchWithoutAdsOffer: () => {
     showPurchaseDialog: () => void;
 };
 
-/**
- * Use widget
- * @param widgetId - widget id
- * @public
- */
-export declare const useWidget: (widgetId: string) => {
-    error: string;
-    widget: Widget | null;
-};
-
 /**
  * @public
  */
@@ -2492,11 +2378,6 @@ export declare interface VideoExternals {
 
 declare type VideoPath = string;
 
-/**
- * @public
- */
-export declare const VideosContext: React_2.Context<DataState<Video>>;
-
 /**
  * Video type.
  * @public
@@ -2557,6 +2438,15 @@ declare type Voucher = {
     voucherInfo: SubscriptionInfo | TransactionInfo;
 };
 
+/**
+ * @public
+ */
+export declare type WebosDeviceInfo = {
+    type: 'webos';
+    model?: string;
+    osVersion?: string;
+};
+
 /**
  * @public
  */