@tivio/sdk-react 9.5.0 → 9.6.0

package/dist/sdk-react.d.ts

@@ -1887,6 +1887,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",
@@ -4013,11 +4014,11 @@ 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"
 }
 
 /**
@@ -5410,6 +5411,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.
@@ -5715,19 +5724,19 @@ 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;
     /**
      * Remove an event listener
      * @param event - The event name to stop listening for
@@ -6374,6 +6383,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;
+    }>;
 }
 
 /**
@@ -6644,7 +6657,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
@@ -6887,7 +6902,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;
@@ -6898,17 +6913,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;
@@ -7814,7 +7823,7 @@ 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;
     /**
@@ -8318,6 +8327,7 @@ export declare interface Watermark {
 
 export declare interface WebConfig {
     customer: CustomerId;
+    customerName?: string;
     title?: string;
     description?: string;
     logo: string;
@@ -8333,16 +8343,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
@@ -8385,6 +8414,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;
@@ -8400,6 +8442,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.
      */
@@ -8418,6 +8468,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.
@@ -8445,6 +8499,7 @@ export declare interface WebConfig {
      */
     showChooseSubscription?: boolean;
     registration?: {
+        logoMarginTop?: string;
         /**
          * Customization of auth form
          */
@@ -8464,6 +8519,7 @@ export declare interface WebConfig {
             showAcceptanceOfTermsAndConditions?: boolean;
         };
         registrationConsent?: string;
+        socialRegistrationConsent?: string;
     };
     payment?: {
         paymentConsent?: string;
@@ -8474,9 +8530,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
@@ -8495,6 +8553,8 @@ export declare interface WebConfig {
     };
     monetizationSelectOverlay?: {
         title?: string;
+        benefitLeftIcon?: string;
+        showFullMonetizationOnMobile?: boolean;
     };
     /**
      * Google Analytics ID. If provided, Google Analytics will be enabled.
@@ -8506,6 +8566,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;
@@ -8520,11 +8581,24 @@ 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
      */
@@ -8634,6 +8708,7 @@ export declare interface WebPlayerProps {
     hideOverlay?: boolean;
     sourcePlayMode?: SourcePlayMode;
     adsConfig?: StaticAdsBreak[];
+    userAuthCallbacks?: SDKUserAuthCallbacks;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tivio/sdk-react",
-    "version": "9.5.0",
+    "version": "9.6.0",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "source": "src/index.ts",
@@ -38,7 +38,7 @@
         "@material-ui/core": "^4.11.2",
         "@material-ui/icons": "^4.11.2",
         "@sentry/browser": "^6.1.0",
-        "@tivio/common": "1.1.135",
+        "@tivio/common": "1.1.136",
         "dayjs": "^1.11.0",
         "es7-object-polyfill": "^1.0.1",
         "firebase": "8.10.1",