@tivio/sdk-react 9.4.0 → 9.6.0

package/dist/sdk-react.d.ts

@@ -1,3 +1,4 @@
+import { AD_SERVICE_PROXY_NAME } from '@tivio/common';
 import type { ComponentType } from 'react';
 import type dayjs from 'dayjs';
 import { DocumentReference } from '@firebase/firestore-types';
@@ -34,6 +35,8 @@ declare interface actualPriceDetails {
     currency?: primaSupportedCurrency;
 }
 
+export { AD_SERVICE_PROXY_NAME }
+
 export declare type AdBannerScene = InteractiveWidgetSceneBase<InteractiveWidgetSceneTemplateType.AD_BANNER>;
 
 export declare type AddEditCommentResponse = {
@@ -100,6 +103,7 @@ export declare type AdMetadata = {
     isSkippable: boolean;
     order: number | null;
     totalCount: number | null;
+    customAdMetadata?: Record<string, unknown>;
     skip: () => void;
 } | null;
 
@@ -217,6 +221,10 @@ export declare interface AdSourceInterface extends CommonSourceInterface<SourceT
     skipAll(): void;
     onRemainingTimeChanged(ms: number): void;
     click(): void;
+    /**
+     * Rich IMA ad metadata including customAdMetadata (only available for IMA ads)
+     */
+    imaAdMetadata?: any;
 }
 
 /**
@@ -675,6 +683,8 @@ export declare interface ButtonOptions {
  */
 export declare interface ButtonVariantOptions {
     border?: string;
+    disabledBackgroundColor?: string;
+    disabledColor?: string;
 }
 
 /**
@@ -1249,7 +1259,8 @@ export declare enum CustomerId {
     KAROL_A_KVIDO = "KAROL_A_KVIDO",
     UZ_BUDU = "UZ_BUDU",
     PRIMA = "PRIMA",
-    NORA_FRIDRICHOVA = "NORA_FRIDRICHOVA"
+    NORA_FRIDRICHOVA = "NORA_FRIDRICHOVA",
+    LONGEVITY = "LONGEVITY"
 }
 
 /**
@@ -1447,6 +1458,15 @@ export declare interface Customizations {
         color?: string;
         backgroundColorActive?: string;
         formBackgroundColor?: string;
+        captionColor?: string;
+        textInputBorder?: string;
+    };
+    MobilePayment?: {
+        backgroundColor?: string;
+        color?: string;
+        backgroundColorActive?: string;
+        formBackgroundColor?: string;
+        captionColor?: string;
     };
     QerkoOverlay?: {
         backgroundColor?: string;
@@ -1867,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",
@@ -3349,6 +3370,20 @@ export declare interface PartialRegistrationOverlayContextState {
     voucher?: string;
 }
 
+/**
+ * @public
+ * Generic interface for sources that can be identified by a path (video or TV channel)
+ */
+export declare type PathSourceParams = PathSourceParamsTvChannel | PathSourceParamsVideo;
+
+declare interface PathSourceParamsTvChannel extends Partial<ChannelSourceParams> {
+    path: `tvChannels/${string}`;
+}
+
+declare interface PathSourceParamsVideo extends Partial<Omit<VodTivioSourceParams, 'videoPath'>> {
+    path: `videos/${string}`;
+}
+
 export declare type PatreonCreatorData = {
     campaign: string;
     tiers: Tier[];
@@ -3795,6 +3830,7 @@ export declare interface PlayerSourceInterface<T extends NonAdSourceType = NonAd
     start?: Date;
     from?: Date;
     sourceHistory?: string[];
+    staticAdsConfig?: StaticAdsBreak[];
 }
 
 /**
@@ -3813,6 +3849,7 @@ export declare interface PlayerSourceParams<T extends NonAdSourceType = NonAdSou
     seekingMatrix?: SeekingMatrixTemplate;
     sessionType?: VideoSourceField['sessionType'];
     sessionId?: string;
+    staticAdsConfig?: StaticAdsBreak[];
 }
 
 export declare type PlayersScene = InteractiveWidgetSceneBase<InteractiveWidgetSceneTemplateType.PLAYERS>;
@@ -3973,7 +4010,15 @@ export declare enum PlayerWrapperEvents {
     /**
      * Un-pause was triggered
      */
-    'unpause_triggered' = "unpause_triggered"
+    'unpause_triggered' = "unpause_triggered",
+    /**
+     * Triggered when an ad starts playing
+     */
+    'ad-started' = "ad-started",
+    /**
+     * Triggered when an ad finishes playing
+     */
+    'ad-ended' = "ad-ended"
 }
 
 /**
@@ -4233,6 +4278,11 @@ export declare type Purchase = {
     voucherId: string | null;
     isVoucherActivation?: boolean;
     rebalancingVideoRef?: any;
+    /**
+     * Returns all purchases that are connected via originalPurchaseRef.
+     * For example, if user has subscription purchase, this method will return all purchases that are RENEWED + PAID/CANCELLED latest one.
+     */
+    getRelatedPurchases: () => Promise<Purchase[]>;
 };
 
 /**
@@ -5361,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.
@@ -5664,6 +5722,21 @@ export declare interface SimplifiedVideoController {
         muted: boolean;
         volume: number;
     }) => void): void;
+    /**
+     * Add an event listener for ad started events
+     * @param event - Must be 'ad-started'
+     * @param callback - Function called when an ad starts playing
+     */
+    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 callback - Function called when an ad finishes playing
+     */
+    addEventListener(event: 'ad-ended', callback: () => void): void;
     /**
      * Remove an event listener
      * @param event - The event name to stop listening for
@@ -5675,6 +5748,7 @@ export declare interface SimplifiedVideoController {
      * @param source - The new source to load (can be a video path, channel path, or source parameters)
      */
     setSource(source: WebPlayerProps['source']): void;
+    setAdsConfig(adsConfig: StaticAdsBreak[]): void;
     /**
      * Destroy the player and clean up all resources
      */
@@ -5794,6 +5868,19 @@ export declare interface StartLiveStreamResponse {
     error?: string;
 }
 
+export declare type StaticAdsBreak = StaticAdsBreakPostrollPreroll | StaticAdsBreakMidroll;
+
+export declare interface StaticAdsBreakMidroll {
+    type: 'midroll';
+    from: number;
+    url: string;
+}
+
+declare interface StaticAdsBreakPostrollPreroll {
+    type: 'preroll' | 'postroll';
+    url: string;
+}
+
 /**
  * @public
  */
@@ -6296,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;
+    }>;
 }
 
 /**
@@ -6357,6 +6448,12 @@ export declare interface TivioConfig {
      * (otherwise organizations would share login token).
      */
     customerId?: CustomerId;
+    /**
+     * An optional variable that enables Single Sign-On (SSO) for all subdomains under the same parent domain.
+     * @example
+     * customTokenCookiesDomain: 'example.com'
+     */
+    customTokenCookiesDomain?: string;
 }
 
 /**
@@ -6560,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
@@ -6803,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;
@@ -6814,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;
@@ -7588,6 +7681,7 @@ export declare enum VastProvider {
     TEST = "test",
     TEST_VPAID = "test-vpaid",
     TIVIO_ADS = "tivio-ads",
+    STATIC_ADS_PROVIDER = "static-ads-provider",
     JOJ_TEST_AD_FORM_PROGRAMMATIC = "joj-test-ad-form-programmatic",
     JOJ_TEST_TESTER_VASTERIX = "joj-test-tester-vasterix",
     JOJ_TEST_TESTER_ADFORM_30 = "joj-test-tester-adform-30"
@@ -7729,6 +7823,9 @@ export declare interface VideoController {
         muted: boolean;
         volume: number;
     }) => void): void;
+    addEventListener(event: 'ad-started', callback: (value: AdMetadata & {
+        adCtaElement: HTMLElement | null;
+    }) => void): void;
     /**
      * Remove an event listener
      * @param event - The event name to stop listening for
@@ -7854,6 +7951,7 @@ export declare interface VideoController {
      * @param mutations - Array of DOM mutation records
      */
     onWatermarkElementChange(mutations: MutationRecord[]): void;
+    setAdCtaElement: (element: HTMLElement | null) => void;
 }
 
 declare type VideoDetailResponsiveField = OrganizationResponsiveSetting<{
@@ -8229,6 +8327,7 @@ export declare interface Watermark {
 
 export declare interface WebConfig {
     customer: CustomerId;
+    customerName?: string;
     title?: string;
     description?: string;
     logo: string;
@@ -8244,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
@@ -8296,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;
@@ -8311,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.
      */
@@ -8329,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.
@@ -8356,6 +8499,7 @@ export declare interface WebConfig {
      */
     showChooseSubscription?: boolean;
     registration?: {
+        logoMarginTop?: string;
         /**
          * Customization of auth form
          */
@@ -8375,6 +8519,7 @@ export declare interface WebConfig {
             showAcceptanceOfTermsAndConditions?: boolean;
         };
         registrationConsent?: string;
+        socialRegistrationConsent?: string;
     };
     payment?: {
         paymentConsent?: string;
@@ -8385,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
@@ -8406,6 +8553,8 @@ export declare interface WebConfig {
     };
     monetizationSelectOverlay?: {
         title?: string;
+        benefitLeftIcon?: string;
+        showFullMonetizationOnMobile?: boolean;
     };
     /**
      * Google Analytics ID. If provided, Google Analytics will be enabled.
@@ -8417,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;
@@ -8431,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
      */
@@ -8458,7 +8621,7 @@ export declare interface WebGridScreenProps {
  */
 export declare interface WebPlayerProps {
     id: string;
-    source?: InputSourceParams | VideoPath | ChannelPath | null;
+    source?: InputSourceParams | PathSourceParams | VideoPath | ChannelPath | null;
     onEnded?: () => any;
     /**
      * If true, the player will inherit the width and height of its parent element.
@@ -8544,6 +8707,8 @@ export declare interface WebPlayerProps {
     setPaymentOverlayVisible?: React_2.Dispatch<React_2.SetStateAction<boolean>>;
     hideOverlay?: boolean;
     sourcePlayMode?: SourcePlayMode;
+    adsConfig?: StaticAdsBreak[];
+    userAuthCallbacks?: SDKUserAuthCallbacks;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tivio/sdk-react",
-    "version": "9.4.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.134",
+        "@tivio/common": "1.1.136",
         "dayjs": "^1.11.0",
         "es7-object-polyfill": "^1.0.1",
         "firebase": "8.10.1",