@tivio/sdk-react 9.5.0 → 9.7.0

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import type { default as firebase_2 } from '@firebase/app-types';
 import type { default as firebase_3 } from 'firebase';
 import { FunctionComponentElement } from 'react';
 import type { GeoPoint } from '@firebase/firestore-types';
+import type { google } from '@alugha/ima';
 import { OperatingSystem } from 'detect-browser';
 import type { PaletteType } from '@material-ui/core';
 import { default as React_2 } from 'react';
@@ -429,6 +430,8 @@ export declare interface Article extends RowItem, MonetizableItem, ReactableCont
     detailBanner?: string;
     episodeNumber?: number;
     seasonNumber?: number;
+    urlNames?: string[];
+    urlName?: string;
 }
 
 /**
@@ -440,10 +443,13 @@ export declare interface ArticleBlock {
     type: ArticleBlockType;
     htmlContent?: string;
     imageUrl?: string;
+    imageUrlOriginal?: string;
+    imageUrlContain?: string;
     textContent?: string;
     videoId?: string;
     isOverflowImage?: boolean;
     imageDescription?: string;
+    use16By9Container?: boolean;
 }
 
 export declare interface ArticleBlockField extends Omit<ArticleBlock, 'textContent' | 'htmlContent'> {
@@ -462,6 +468,7 @@ export declare type ArticleBlockType = 'PARAGRAPH' | 'IMAGE' | 'VIDEO' | 'HEADIN
  */
 declare interface ArticleDocumentSerialized {
     type: 'ARTICLE';
+    id: string;
     name: Translation;
     description?: Translation;
     metadata?: ArticleMetadata;
@@ -503,6 +510,7 @@ export declare interface ArticleTileSpecificData {
     description?: Translation;
     monetizations?: TileMonetizationData[];
     externalUrl?: string;
+    urlName?: UrlNamesType;
 }
 
 /**
@@ -811,6 +819,12 @@ export declare interface CommonSourceParams<T extends SourceType = SourceType> {
     videoPath?: string;
 }
 
+/**
+ * @public
+ * Re-export of Google IMA CompanionAd type for use throughout the SDK
+ */
+export declare type CompanionAd = google.ima.CompanionAd;
+
 /**
  * Just another alias. Reexported for backward compatibility.
  * @public
@@ -1071,6 +1085,9 @@ export declare const CountryToLangCodeMap: {
     CZ: LangCode;
     PL: LangCode;
     SK: LangCode;
+    DE: LangCode;
+    AT: LangCode;
+    CH: LangCode;
 };
 
 /**
@@ -1210,6 +1227,7 @@ export declare enum CustomerId {
     MIRA_BOSAK = "MIRA_BOSAK",
     KOVACIC_360 = "KOVACIC_360",
     SIFRA_TV = "SIFRA_TV",
+    TBL = "TBL",
     BLESK = "BLESK",
     NERUDA_TV = "NERUDA_TV",
     DAVID_FRANK_TV = "DAVID_FRANK_TV",
@@ -1226,6 +1244,7 @@ export declare interface CustomScript {
     src: string;
     event?: EventName;
     isAsync?: boolean;
+    defer?: boolean;
 }
 
 /**
@@ -1510,6 +1529,7 @@ export declare interface EmitterInterface {
     isSupported: (even: string) => boolean;
     addListener: <T = unknown>(event: string, cb: (value: T) => Empty_2) => void;
     removeListener: <T = unknown>(event: string, cb: (value: T) => Empty_2) => void;
+    emitEvent: (event: string, value?: unknown) => void;
 }
 
 /**
@@ -1576,6 +1596,15 @@ export declare const fetchBundle: (secret: string, conf: InternalConfig, checkBu
  */
 declare type FetchPackage = (url: string) => Promise<string>;
 
+export declare interface FinishSignUpRequest {
+    token: string;
+    fName: string;
+    lName: string;
+    email: string;
+    password: string;
+    langCode?: LangCode;
+}
+
 /**
  * @public
  */
@@ -1603,6 +1632,7 @@ export declare interface ForbiddenOnCallError extends GenericOnCallError {
 }
 
 export declare enum ForbiddenReason {
+    AD_BLOCKING = "AD_BLOCKING",
     MONETIZATION = "MONETIZATION",
     GEO_BLOCKING = "GEO_BLOCKING",
     EMAIL_ALREADY_EXISTS = "EMAIL_ALREADY_EXISTS",
@@ -1665,9 +1695,13 @@ export declare type GeoBlocking = {
     blacklist: Array<any>;
 };
 
-export declare interface GetArticleRequest {
+export declare type GetArticleRequest = {
     id: string;
-}
+} | {
+    idOrUrlName: string;
+    organizationId: string;
+    language: LangCode;
+};
 
 export declare interface GetArticleResponse {
     article: ArticleDocumentSerialized;
@@ -2280,12 +2314,16 @@ export declare enum LangCode {
     HU = "hu"
 }
 
+export declare const LangCodeToTitle: Partial<Record<LangCode, string>>;
+
 /**
  * All supported languages codes as in ISO 639-1
  * @public
  */
 export declare const languages: LangCode[];
 
+export declare type LanguageSelector = 'application' | 'content';
+
 /**
  * Possible language key of all supported language mutations.
  * @public
@@ -2334,7 +2372,13 @@ export declare interface LeaderboardsRequest {
  */
 export declare interface LinkedVideo {
     video: Video;
-    type: 'CUT' | 'TRAILER' | 'BONUS' | 'CHILD' | 'TEASER' | 'TASTING' | 'VIRTUAL_PROGRAM' | 'LANGUAGE'
+    type: 'CUT' | 'TRAILER' | 'BONUS' | 'CHILD'
+    /**
+    * Recommendation for the video that appears ahead of
+    * algorithmic recommendations on the detail page. Works one-way: if A
+    * links to B, B is recommended for A only (unless B links back).
+    */
+    | 'RECOMMENDED' | 'TEASER' | 'TASTING' | 'VIRTUAL_PROGRAM' | 'LANGUAGE'
     /**
     * Will render separate mini-player on top of the main one, playing given video.
     */
@@ -2874,11 +2918,6 @@ export declare type Nullable<T> = {
     [P in keyof T]: T[P] | null;
 };
 
-/**
- * @public
- */
-export declare type ObjectType = Record<string, any>;
-
 /**
  * @public
  */
@@ -3624,6 +3663,7 @@ export declare interface PlayerWrapper {
     isPaused: boolean;
     isPlaying: boolean;
     isIdle: boolean;
+    isFullscreen: boolean;
     language: LangCode | null;
     nextRecommendedVideo: Video | null;
     prerollCheck: PrerollCheck;
@@ -3709,11 +3749,15 @@ export declare enum PlayerWrapperEvents {
     /**
      * Triggered when an ad starts playing
      */
-    'ad_started' = "ad_started",
+    'ad-started' = "ad-started",
     /**
      * Triggered when an ad finishes playing
      */
-    'ad_ended' = "ad_ended"
+    'ad-ended' = "ad-ended",
+    /**
+     * Triggered when companion ads are available for the current ad
+     */
+    'companion-ads' = "companion-ads"
 }
 
 /**
@@ -5097,6 +5141,14 @@ export declare type SdkReactConfig = Omit<TivioConfig, 'language'> & {
     language?: LangCode;
 };
 
+/**
+ * @public
+ */
+export declare interface SDKUserAuthCallbacks {
+    onGoToLogin?: () => void;
+    onGoToRegistration?: () => void;
+}
+
 /**
  * @public
  * @deprecated sections are no longer used.
@@ -5402,19 +5454,25 @@ export declare interface SimplifiedVideoController {
     }) => void): void;
     /**
      * Add an event listener for ad started events
-     * @param event - Must be 'ad_started'
+     * @param event - Must be 'ad-started'
      * @param callback - Function called when an ad starts playing
      */
-    addEventListener(event: 'ad_started', callback: (adMetadata: AdMetadata & {
+    addEventListener(event: 'ad-started', callback: (adMetadata: AdMetadata & {
         customAdMetadata?: Record<string, unknown> | null;
         ctaElement: HTMLElement | null;
     }) => void): void;
     /**
      * Add an event listener for ad ended events
-     * @param event - Must be 'ad_ended'
+     * @param event - Must be 'ad-ended'
      * @param callback - Function called when an ad finishes playing
      */
-    addEventListener(event: 'ad_ended', callback: () => void): void;
+    addEventListener(event: 'ad-ended', callback: () => void): void;
+    /**
+     * Add an event listener for companion ads events
+     * @param event - Must be 'companion-ads'
+     * @param callback - Function called when companion ads are available
+     */
+    addEventListener(event: 'companion-ads', callback: (companionAds: CompanionAd[]) => void): void;
     /**
      * Remove an event listener
      * @param event - The event name to stop listening for
@@ -5975,6 +6033,10 @@ export declare interface TivioComponents {
     ContentSortPicker: React_2.ComponentType<ContentSortPickerProps>;
     WebTivioProVideoScreen: React_2.ComponentType<WebTivioProVideoScreenProps>;
     RemoteController: React_2.ComponentType<RemoteControllerProps>;
+    MonetizationsSelectOverlay: React_2.ComponentType;
+    MonetizationsSelectOverlayContextProvider: React_2.ComponentType<{
+        children: React_2.ReactNode;
+    }>;
 }
 
 /**
@@ -5999,7 +6061,7 @@ export declare interface TivioConfig {
     };
     secret: string;
     /**
-     * Language used when isLanguageSelectionEnabled is false | undefined or when not possible to load language from local storage or localization worker
+     * Language used when no languageSelector is set or when not possible to load language from local storage or localization worker
      */
     language: LangCode;
     debug?: boolean;
@@ -6007,15 +6069,16 @@ export declare interface TivioConfig {
     firebaseApp?: any | null;
     firebaseFactory?: (config: object, appName?: string) => firebase_2.FirebaseApp;
     authDomainOverride?: string;
+    /**
+     * @deprecated this field is no longer in use and has no impact when set.
+     */
     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
+     * Represents an optional array of LanguageSelector objects.
+     * Used to define and manage a list of supported languages for different language-usages (user, content,...).
      */
-    isLanguageSelectionEnabled?: boolean;
+    languageSelectors?: Partial<Record<LanguageSelector, LangCode[]>>;
     applicationId?: string;
     isTivioProApp?: boolean;
     lockApplicationHandle?: string;
@@ -6042,6 +6105,7 @@ export declare interface TivioConfig {
      * customTokenCookiesDomain: 'example.com'
      */
     customTokenCookiesDomain?: string;
+    enableGtmPlayerEvents?: boolean;
 }
 
 /**
@@ -6245,7 +6309,9 @@ export declare type TivioInternalProviders = {
     UserContextProvider: React_2.ComponentType<{
         children?: React_2.ReactNode;
     }>;
-    MonetizationsSelectOverlayContextProvider: React_2.ComponentType;
+    MonetizationsSelectOverlayContextProvider: React_2.ComponentType<{
+        children: React_2.ReactNode;
+    }>;
     QerkoOverlayContextProvider: React_2.ComponentType;
     /**
      * @deprecated do not use, this provider will be removed in the future
@@ -6285,12 +6351,18 @@ export declare type TivioJsBundleExposedApi = {
     /**
      * Get tag by its id.
      * @param tagId - tag id
-     * @returns {Promise<Tag | null>} widget or null if tag does not exists
+     * @returns {Promise<Tag | null>} tag or null if tag does not exists
      */
     getTagById: (tagId: string) => Promise<Tag | null>;
+    /**
+     * Get tags by their ids.
+     * @param tagIds - tag ids
+     * @returns {Promise<Tag[]} list of tags for given ids
+     */
+    getTagsByIds: (tagIds: string[]) => Promise<Tag[]>;
     createPlayerWrapper: (playerImplementation: PlayerInterfaceForPlayerWrapper) => TivioPlayerWrapper;
     destroy: () => Promise<void>;
-} & Pick<TivioGetters, 'getVideoById' | 'getScreenById' | 'organization' | 'getUser'> & Pick<TivioSubscriptions, 'subscribeToVideo' | 'subscribeToItemsInRow' | 'subscribeToRowsInScreen'> & Pick<TivioAuth, 'createUserWithEmailAndPassword' | 'signInWithEmailAndPassword' | 'resetPassword' | 'signOut'> & Pick<TivioSetters, 'setBundleVersion' | 'setUser' | 'setLanguage' | 'setStorageManager'>;
+} & Pick<TivioGetters, 'getVideoById' | 'getScreenById' | 'organization' | 'getUser'> & Pick<TivioSubscriptions, 'subscribeToVideo' | 'subscribeToItemsInRow' | 'subscribeToRowsInScreen'> & Pick<TivioAuth, 'createUserWithEmailAndPassword' | 'signInWithEmailAndPassword' | 'resetPassword' | 'signOut'> & Pick<TivioSetters, 'setBundleVersion' | 'setUser' | 'setLanguage' | 'setContentLanguage' | 'setStorageManager'>;
 
 /**
  * @public
@@ -6362,6 +6434,7 @@ export declare type TivioSetters = {
      * @param language
      */
     setLanguage: (language: LangCode) => void;
+    setContentLanguage: (language: LangCode) => void;
     setStorageManager: (storageManager: StorageManager_2) => void;
     setUser: (userId: string | null, userPayload?: UserPayload) => Promise<void>;
 };
@@ -6390,10 +6463,6 @@ export declare type TivioSubscriptions = {
     subscribeToItemsInRow: SubscribeToItemsInRow;
     subscribeToRowsInScreen: SubscribeToRowsInScreen;
     subscribeToTaggedVideos: SubscribeToTaggedVideos;
-    registerOverlayCallbacks: (callbacks: {
-        onShow: () => void;
-        onHide: () => void;
-    }) => void;
 };
 
 /**
@@ -6480,7 +6549,7 @@ export declare interface TvAppProps {
 /**
  * @public
  */
-export declare interface TvChannel extends RowItem {
+export declare interface TvChannel extends RowItem, MonetizableItem {
     id: string;
     itemType: ROW_ITEM_TYPES.TV_CHANNEL;
     name: string;
@@ -6491,17 +6560,11 @@ export declare interface TvChannel extends RowItem {
     logoPendingOverlayWidth?: string;
     hls: string;
     dash: string;
-    /**
-     * Returns all transactions and subscriptions applied to this tv channel.
-     * Transactions before subscriptions, sorted by price ascending.
-     */
-    getPurchasableMonetizations(options?: GetPurchasableMonetizationsOptions): PurchasableMonetization[];
     getSourceUrl(options?: {
         language?: LangCode;
     }): Promise<GetSourceUrlResponse & {
         language?: LangCode;
     }>;
-    purchasableMonetization: any | null;
     price: number;
     cover: string;
     isPlayable: boolean;
@@ -6615,6 +6678,10 @@ export declare type UpdateNotificationSettingsResponse = Promise<boolean>;
 
 export declare type UpsertCommentResponse = AddEditCommentResponse | DeleteCommentResponse;
 
+export declare type UrlNamesType = {
+    [key in LangCode]?: string[];
+};
+
 /**
  * @public
  */
@@ -7244,23 +7311,18 @@ export declare type VastApiFramework = string | 'VPAID' | null;
  * @public
  */
 export declare enum VastProvider {
-    CNC_PREBID = "cnc-prebid",
     CNC_STARGAZE_PREROLL_1 = "cnc-stargaze-preroll-1",
     CNC_STARGAZE_PREROLL_2 = "cnc-stargaze-preroll-2",
     CNC_STARGAZE_MIDROLL = "cnc-stargaze-midroll",
-    ETARGET_PREBID = "etarget-prebid",
     FALLBACK_HLS = "fallback-hls",
     FALLBACK_MP4 = "fallback",
     GARAZ_TV = "garaz.tv",
     GARAZ_TV_DEV = "garaz.tv.dev",
-    IMPRESSION_MEDIA_PREBID = "impressionMedia-prebid",
     JOJ_ADFORM = "joj",
     JOJ_SMART = "joj-smart",
     JOJ_AD_MANAGER_VOD_PREROLL = "joj-ad-manager-vod-preroll",
     JOJ_AD_MANAGER_VOD_MIDROLL = "joj-ad-manager-vod-midroll",
     JOJ_AD_MANAGER_LIVE_PREROLL = "joj-ad-manager-live-preroll",
-    MALL_TV = "malltv",
-    MALL_TV_PREBID = "malltv-prebid",
     PRIMA = "prima",
     TEST = "test",
     TEST_VPAID = "test-vpaid",
@@ -7372,6 +7434,7 @@ export declare interface Video extends RowItem, MonetizableItem, ReactableConten
     forcedCapabilities: PlayerCapability[] | null;
     mainLinkedVideoId?: string;
     getLinkedVideoIdByLanguage: (lang: LangCode) => string | undefined;
+    externals?: VideoExternals;
 }
 
 /**
@@ -7407,9 +7470,10 @@ export declare interface VideoController {
         muted: boolean;
         volume: number;
     }) => void): void;
-    addEventListener(event: 'ad_started', callback: (value: AdMetadata & {
+    addEventListener(event: 'ad-started', callback: (value: AdMetadata & {
         adCtaElement: HTMLElement | null;
     }) => void): void;
+    addEventListener(event: 'companion-ads', callback: (value: CompanionAd[]) => void): void;
     /**
      * Remove an event listener
      * @param event - The event name to stop listening for
@@ -7665,7 +7729,7 @@ export declare interface VideoTileSpecificData {
     assets?: AssetsField;
     episodeNumber?: number;
     seasonNumber?: number;
-    urlName?: VideoUrlNames;
+    urlName?: UrlNamesType;
     monetizations?: VideoTileMonetizationData[];
     description?: Translation;
 }
@@ -7734,13 +7798,6 @@ export declare enum VideoType {
     CHILD = "CHILD"
 }
 
-/**
- * @public
- */
-export declare type VideoUrlNames = {
-    [key in LangCode]?: string[];
-};
-
 export declare interface ViewCountItem {
     /**
      * Unix timestamp
@@ -7911,6 +7968,7 @@ export declare interface Watermark {
 
 export declare interface WebConfig {
     customer: CustomerId;
+    customerName?: string;
     title?: string;
     description?: string;
     logo: string;
@@ -7926,16 +7984,35 @@ export declare interface WebConfig {
          * Text on buy voucher button, if not provided the default text will be used.
          */
         buyVoucherButtonText?: string;
+        /**
+         * If true, the voucher button will be shown in the header.
+         */
+        showVoucherButton?: boolean;
         allowSearch?: boolean;
         logoHeight?: string;
         mobileLogoHeight?: string;
         buySubscriptionButtonText?: string;
+        isHidden?: boolean;
+        /**
+         * Additional menu items to be shown in the rounded menu in the header (external or internal)
+         */
+        additionalMenuItems?: {
+            name: string;
+            href: string;
+            newTab?: boolean;
+        }[];
     };
     footer?: {
+        isHidden?: boolean;
         /**
          * If logo is different from logo in header
          */
         logo?: string;
+        /**
+         * @fixme https://app.clickup.com/t/90151157205/TIV-1515
+         * If multiple logos are provided, the multiple logos are prioritized over the single logo.
+         */
+        multipleLogos?: string[];
         showLogo?: boolean;
         /**
          * right panel - various type of contacts to owners of website
@@ -7978,6 +8055,19 @@ export declare interface WebConfig {
             email?: string;
         };
         cookieSettingsLabel?: string;
+        disclaimer?: string;
+        showDivider?: boolean;
+        /**
+         * Additional links to be shown in the footer
+         */
+        additionalLinks?: {
+            name: string;
+            href: string;
+        }[];
+        /**
+         * Hide footer on these paths
+         */
+        hideFooter?: string[];
         partners?: {
             name: string;
             logo: string;
@@ -7993,6 +8083,14 @@ export declare interface WebConfig {
      * so app requires authorization to see them.
      */
     securedContent?: boolean;
+    /**
+     * If true, then auth is required for all pages.
+     */
+    isAuthRequired?: boolean;
+    /**
+     * If true, then buy subscription button is hidden.
+     */
+    hideBuySubscriptionButton?: boolean;
     /**
      * CSS styles for application background.
      */
@@ -8011,6 +8109,10 @@ export declare interface WebConfig {
          * Default is TRUE (see {@link AppLoadingOverlay}
          */
         showProgressBar?: boolean;
+        /**
+         * URL to background image shown on loading screen.
+         */
+        backgroundUrl?: string;
     };
     /**
      * Slug of all pages where user will be forced to fill login form if he's not logged in.
@@ -8038,6 +8140,7 @@ export declare interface WebConfig {
      */
     showChooseSubscription?: boolean;
     registration?: {
+        logoMarginTop?: string;
         /**
          * Customization of auth form
          */
@@ -8057,6 +8160,7 @@ export declare interface WebConfig {
             showAcceptanceOfTermsAndConditions?: boolean;
         };
         registrationConsent?: string;
+        socialRegistrationConsent?: string;
     };
     payment?: {
         paymentConsent?: string;
@@ -8067,9 +8171,11 @@ export declare interface WebConfig {
      */
     supportVouchers?: boolean;
     /**
-     * Config for Google Tag Manager
+     * Config for Google Tag Manager with optional shouldWaitForDidomi flag
      */
-    googleTagManagerConfig?: TagManagerArgs;
+    googleTagManagerConfig?: TagManagerArgs & {
+        shouldWaitForDidomi?: boolean;
+    };
     customScripts?: CustomScript[];
     /**
      * Favicons config
@@ -8088,6 +8194,8 @@ export declare interface WebConfig {
     };
     monetizationSelectOverlay?: {
         title?: string;
+        benefitLeftIcon?: string;
+        showFullMonetizationOnMobile?: boolean;
     };
     /**
      * Google Analytics ID. If provided, Google Analytics will be enabled.
@@ -8099,6 +8207,7 @@ export declare interface WebConfig {
     centeredMenu?: boolean;
     /**
      * All values are considered as false if not provided.
+     * @deprecated - use settings.allowedSignInProviders inside OrganizationDocument
      */
     socialLogins?: {
         showAppleLogin?: boolean;
@@ -8113,15 +8222,32 @@ export declare interface WebConfig {
      * If true, robots.txt will prevent crawling of the website.
      */
     norobots?: boolean;
-    customTranslations?: {
-        [key: string]: {
-            [key: string]: string;
-        };
+    voucher?: {
+        voucherConsent: string;
+    };
+    customTranslations?: Record<string, Record<string, string>>;
+    onPurchase?: (monetization: Purchase) => void;
+    facebookPixelConfig?: {
+        pixelId: string;
+        shouldWaitForDidomi?: boolean;
     };
+    /**
+     * If true, the app will be locked in the "remote controller" mode.
+     * This means that the app will not be able to navigate to other pages and will only show the remote controller.
+     */
+    isRemoteControllerApp?: boolean;
+    /**
+     * Determines if application should check allowed URL handles when switching applications.
+     */
+    disableUrlHandleCheck?: boolean;
     /**
      * Map for all handlers
      */
     handlers?: PurchaseEventHandlers;
+    homeScreen?: {
+        useFullHeight?: boolean;
+    };
+    disableModalSwitcher?: boolean;
 }
 
 /**
@@ -8227,6 +8353,7 @@ export declare interface WebPlayerProps {
     hideOverlay?: boolean;
     sourcePlayMode?: SourcePlayMode;
     adsConfig?: StaticAdsBreak[];
+    userAuthCallbacks?: SDKUserAuthCallbacks;
 }
 
 /**