@tivio/sdk-react 9.3.1 → 9.5.0

package/dist/index.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;
 }
 
 /**
@@ -1210,7 +1218,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"
 }
 
 export declare interface CustomScript {
@@ -2030,6 +2039,8 @@ export declare interface IndexedVideo extends IndexedObject {
     monetizationAccessIds: string[] | false;
 }
 
+export declare type InputSourceParams = SourceParams | VodExternalMultiSourceParams;
+
 export declare type IntegrationType = 'discord' | 'patreon';
 
 export declare interface InteractiveWidget<T extends InteractiveWidgetScene = InteractiveWidgetScene> {
@@ -3054,6 +3065,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[];
@@ -3500,6 +3525,7 @@ export declare interface PlayerSourceInterface<T extends NonAdSourceType = NonAd
     start?: Date;
     from?: Date;
     sourceHistory?: string[];
+    staticAdsConfig?: StaticAdsBreak[];
 }
 
 /**
@@ -3518,6 +3544,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>;
@@ -3678,7 +3705,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"
 }
 
 /**
@@ -3938,6 +3973,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[]>;
 };
 
 /**
@@ -5360,6 +5400,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
@@ -5371,6 +5426,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
      */
@@ -5490,6 +5546,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
  */
@@ -5967,6 +6036,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;
 }
 
 /**
@@ -7190,6 +7265,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"
@@ -7331,6 +7407,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
@@ -7456,6 +7535,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<{
@@ -7700,6 +7780,14 @@ export declare interface VirtualChannelSourceParams extends ChannelSourceParams
     drm?: Drm;
 }
 
+/**
+ * Interface representing the parameters for a VOD (Video On Demand) external multi-source configuration.
+ * Multi-source means an array of string URLs representing the external sources for the video content.
+ */
+export declare interface VodExternalMultiSourceParams extends Omit<VodExternalSourceParams, 'url'> {
+    urls: string[];
+}
+
 /**
  * @public
  */
@@ -8052,7 +8140,7 @@ export declare interface WebGridScreenProps {
  */
 export declare interface WebPlayerProps {
     id: string;
-    source?: SourceParams | 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.
@@ -8138,6 +8226,7 @@ export declare interface WebPlayerProps {
     setPaymentOverlayVisible?: React_2.Dispatch<React_2.SetStateAction<boolean>>;
     hideOverlay?: boolean;
     sourcePlayMode?: SourcePlayMode;
+    adsConfig?: StaticAdsBreak[];
 }
 
 /**