@tivio/sdk-react 9.1.7 → 9.2.0-alpha.1

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ComponentType } from 'react';
+import type { ComponentType } from 'react';
 import type dayjs from 'dayjs';
 import { DocumentReference } from '@firebase/firestore-types';
 import type duration from 'dayjs/plugin/duration';
@@ -480,6 +480,7 @@ declare interface ArticleDocumentSerialized {
     monetizations?: TileMonetizationData[];
     seriesPath?: string;
     blocks: ArticleBlockField[] | undefined;
+    externalUrl?: string;
 }
 
 export declare interface ArticleMetadata {
@@ -492,6 +493,7 @@ export declare interface ArticleTileSpecificData {
     assets?: AssetsField;
     description?: Translation;
     monetizations?: TileMonetizationData[];
+    externalUrl?: string;
 }
 
 /**
@@ -1034,10 +1036,9 @@ export declare const createPubSub: () => PubSub;
  */
 export declare const createRemotePackageLoader: () => (secret: string, conf: InternalConfig, checkBundleCharCount?: boolean) => Promise<TivioBundle>;
 
-/**
- * @public
- */
-export declare const createUseRemoteBundle: () => (conf: InternalConfig, checkBundleCharCount?: boolean) => RemoteBundleState;
+export declare const createTivio: () => (conf: SdkReactConfig) => Promise<RemoteBundleState>;
+
+export declare const createUseRemoteBundle: () => (sdkReactConfig: SdkReactConfig, checkBundleCharCount?: boolean) => RemoteBundleState;
 
 export declare interface CreateUserPayload {
     displayName?: string;
@@ -1071,13 +1072,13 @@ export declare const CURRENCIES: string[];
  * Three upper-case letters according to ISO-4217.
  * @public
  */
-export declare type Currency = 'CZK' | 'EUR' | 'USD';
+export declare type Currency = 'CZK' | 'EUR' | 'USD' | 'PLN';
 
 /**
  * Necessary because keys in cloud function config cannot contain upper-case letters.
  * Has to be in sync with {@link Currency}.
  */
-export declare type CurrencyLowerCase = 'czk' | 'eur' | 'usd';
+export declare type CurrencyLowerCase = 'czk' | 'eur' | 'usd' | 'pln';
 
 export declare interface CurrentQuestion {
     id: string;
@@ -1787,6 +1788,8 @@ export declare interface GetViewAnalyticsResponse {
 
 export declare type GetViewsAnalyticsRequest = GetBaseAnalyticsRequest;
 
+export declare let globalSdkReactConfig: SdkReactConfig | undefined;
+
 /**
  * @public
  */
@@ -2840,6 +2843,9 @@ export declare interface OrganizationSettingsField extends OrganizationResponsiv
         tagModal?: {
             hideTitle?: boolean;
         };
+        seriesModal?: {
+            hideHeader?: boolean;
+        };
     };
     voucher?: VoucherPageConfiguration;
 }
@@ -3206,6 +3212,18 @@ export declare interface PlayerError {
     timestamp: number;
 }
 
+/**
+ * @public
+ */
+export declare type PlayerEvent = {
+    name: PlayerEventName;
+};
+
+/**
+ * @public
+ */
+export declare type PlayerEventName = `${PlayerWrapperEvents}`;
+
 /**
  * @public
  */
@@ -3333,7 +3351,6 @@ export declare interface PlayerSourceInterface<T extends NonAdSourceType = NonAd
     pauseReactions(): void;
     correctStartPosition(): Promise<void | null>;
     setCanSeek(canSeek: boolean): void;
-    getOffset(): number;
     getSeekingMatrixPreviewByTime(timeMs: number, offsetIndex?: number): SeekingMatrix | null;
     originalOptions: Record<string, any>;
     start?: Date;
@@ -3402,11 +3419,20 @@ export declare interface PlayerWrapper {
      * Pause video
      */
     pause: () => void;
+    ad: AdSourceInterface | null;
+    adMetadata: AdMetadata | null;
+    adSegment: AdSegment | null;
+    availableLanguages: LangCode[] | null;
+    canReplay: boolean;
+    currentSecondarySource: Video | null;
+    currentTime: number;
     /**
      * Currently playing source
      */
     source: PlayerSource | null;
+    seekInterceptor: SeekInterceptor;
     events: EmitterInterface;
+    event: PlayerEvent | null;
     /**
      * Register a low level player that implements player methods, like play video, change volume, etc.
      */
@@ -3414,12 +3440,30 @@ export declare interface PlayerWrapper {
     /**
      * duration of current source in ms (both setter and getter)
      */
-    durationMs: number | null;
+    durationMs: number;
+    intro: {
+        marker: any;
+        skip: () => void;
+    } | null;
+    isBuffering: boolean;
+    isCurrentTimeLive: boolean;
+    isLiveSeekingEnabled: boolean;
+    isMuted: boolean;
     isPlaybackStarted?: boolean;
     isPaused: boolean;
     isPlaying: boolean;
     isIdle: boolean;
+    language: LangCode | null;
+    nextRecommendedVideo: Video | null;
+    prerollCheck: PrerollCheck;
+    previousSource: PlayerSource | null;
+    progress: number | null;
+    progressMetadata: ProgressMetadata;
+    requestedSource: PlayerSource | null;
+    secondaryVideos: Video[] | null;
     error: PlayerError | null;
+    state: PlayerState;
+    volume: number;
     playbackError: PlayerError | null;
     canPlay: boolean;
     /**
@@ -3436,6 +3480,8 @@ export declare interface PlayerWrapper {
      * set volume to value between 0,1
      */
     setVolume: (volume: number) => void;
+    changeLanguage: (langCode: LangCode) => Promise<void>;
+    changeToFallbackSource: () => Promise<void>;
     /**
      * change volume by value between -1,1
      */
@@ -3443,7 +3489,52 @@ export declare interface PlayerWrapper {
     setMuted: (muted: boolean) => void;
     setCanPlay: (canPlay: boolean) => void;
     toggleMuted: () => void;
+    getQualities: () => Track[];
+    playNativeImaAd: (url: string) => void;
+    playSourceAfterAdsRun: () => void;
+    putAd: (ad: AdSourceInterface) => void;
+    putAdMetadata: (ad: AdSourceInterface) => void;
+    reportLoadError: (error: Error) => void;
+    reportStateChanged: (state: PlayerState) => void;
+    reportTimeProgress: (ms: number) => void;
+    reportPlaybackCancelled: () => void;
+    reportPlaybackError: (error: Error) => void;
+    reportPlaybackEnded: () => void;
     resetErrors(): void;
+    seekToPercent: (percentage: number) => void;
+    seekToInternal: (ms: number) => void;
+    seekToLive: () => void;
+    seekToLiveInternal: () => void;
+    setIsBuffering: (isBuffering: boolean) => void;
+    setIsCasting: (isCasting: boolean) => void;
+    skipAd: () => void;
+    skipAllAds: () => void;
+    switchSecondarySource: (activeVideoId?: string) => Promise<void>;
+}
+
+/**
+ * @public
+ */
+export declare enum PlayerWrapperEvents {
+    'playback_cancelled' = "playback_cancelled",
+    /**
+     * Triggered when content video or ad finished playing until the end
+     */
+    'playback_ended' = "playback_ended",
+    /**
+     * Triggered when both content video and all its associated ads finished playing until the end.
+     * Or in case of postroll, when content video finished playing unit the end and all postroll
+     * ads either finished / failed or were skipped.
+     */
+    'video_unit_ended' = "video_unit_ended",
+    /**
+     * Pause was triggered
+     */
+    'pause_triggered' = "pause_triggered",
+    /**
+     * Un-pause was triggered
+     */
+    'unpause_triggered' = "unpause_triggered"
 }
 
 /**
@@ -3459,6 +3550,18 @@ export declare enum PlayerWrapperEventType {
  */
 export declare type PlayerWrapperEventTypeType = `${PlayerWrapperEventType}`;
 
+/**
+ * @public
+ */
+/**
+ * A promise that ads will be loaded. Resolves to the first ad source,
+ * other ads are linked to it via `ad.next` attribute.
+ *
+ * In case preroll is not configured or no ad
+ * manages to load successfully, resolves to null.
+ */
+export declare type PrerollCheck = (source: PlayerSource) => Promise<AdSourceInterface | null>;
+
 export declare enum primaPlusMonetizationLevel {
     light = "z7soJTA2dYSxnOOJw7B0",
     premium = "kwfM0D7Vzv5wfLf5go8o",
@@ -3541,6 +3644,18 @@ export declare type ProfileSurvey = {
     age?: AgeRange;
 };
 
+/**
+ * @public
+ */
+export declare interface ProgressMetadata {
+    currentTimeMs: number;
+    durationMs: number;
+    percent: number;
+    remainingMs: number;
+    type: 'original' | 'cutout';
+    cutout?: Cutout;
+}
+
 /**
  * @public
  */
@@ -4176,10 +4291,11 @@ declare type Relationship = {
  * @public
  */
 export declare type RemoteBundleState = {
-    config: InternalConfig;
-    error: string | null;
     state: 'loading' | 'error' | 'ready';
-} & Nullable<TivioBundle>;
+    error: string | null;
+    config: InternalConfig;
+    settings: Settings;
+} & Omit<Partial<TivioJsBundleExposedApi>, 'createPlayerWrapper'> & Nullable<TivioBundle>;
 
 export declare interface RemoteControlGenerateSourceResponse {
     sessionId?: string;
@@ -4282,6 +4398,8 @@ export declare interface RenderConditionValue {
     subscriptionRefs?: any[];
 }
 
+export declare const renderWebPlayer: (container: HTMLElement, props: WebPlayerProps) => void;
+
 /**
  * Make all attributes in given type required, non-nullable and defined.
  * e.g. will make `{ attribute?: string | null }` to be `{ attribute: string }`
@@ -4497,6 +4615,14 @@ export declare type RowInScreen = {
      * Setting for decided whether to hide title in the tiles/banners
      */
     hideTitle?: boolean;
+    /**
+     * Link to external URL
+     */
+    externalUrl?: string;
+    /**
+     * Title of Play button
+     */
+    playButtonTitle?: Translation;
 };
 
 /**
@@ -4764,6 +4890,26 @@ export declare interface SeekingMatrixTemplate {
     interval: number;
 }
 
+export declare interface SeekInterceptionResult {
+    position: number | null;
+    didChangePosition: boolean;
+    priority: number;
+}
+
+/**
+ * @public
+ */
+export declare interface SeekInterceptor {
+    addInterceptor(interceptor: SeekInterceptorFunction, callback?: SeekInterceptorCallback): void;
+    applyInterceptors(currentPosition: number, seekPosition: number): SeekInterceptionResult;
+    callCallbacksAfterInterception(): void;
+    removeInterceptor(interceptor: SeekInterceptorFunction): void;
+}
+
+export declare type SeekInterceptorCallback = (requestedSeekPosition: number) => void;
+
+export declare type SeekInterceptorFunction = (currentPosition: number, seekPosition: number) => SeekInterceptionResult;
+
 export declare enum SemanticDate {
     YESTERDAY = "Yesterday",
     TODAY = "Today",
@@ -4833,6 +4979,13 @@ export declare interface SetCustomClaimsRequest {
     organizationId: string;
 }
 
+export declare const setSdkReactConfig: (tivioConfig: SdkReactConfig) => void;
+
+declare type Settings = {
+    onSetUser: (handler: (userId: string, userPayload: UserPayload) => void) => void;
+    setUser: (userId: string, userPayload: UserPayload) => 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.
@@ -5468,7 +5621,7 @@ export declare type TivioGetters = {
          * @returns {Promise<Monetization[] | undefined>} organization subscriptions or undefined if organization does not exists
          */
         getSubscriptions: () => Promise<Monetization[] | undefined>;
-    };
+    } | null;
     /**
      * Get video by its id.
      * @param videoId - video id
@@ -5666,7 +5819,7 @@ export declare type TivioJsBundleExposedApi = {
      * @param id - player wrapper id
      * @returns {Player} player wrapper instance
      */
-    getPlayerWrapper: (id: string) => Player;
+    getPlayerWrapper: (id: string) => PlayerWrapper;
     /**
      * Get tv channel by its id.
      * @param tvChannelId - tv channel id
@@ -5702,18 +5855,17 @@ export declare interface TivioPlayerWrapper {
 /**
  * @public
  */
-export declare const TivioProvider: React_2.FC<TivioProviderProps>;
+export declare const TivioProvider: (props: TivioProviderProps) => React_2.JSX.Element;
 
 /**
  * @public
  */
-export declare type TivioProviderProps = {
+export declare interface TivioProviderProps extends React_2.PropsWithChildren {
     /**
      * This prop must be set only once and not change value afterwards
      */
     conf: SdkReactConfig | undefined | null;
-    children: React_2.ReactNode;
-};
+}
 
 /**
  * @public
@@ -5742,7 +5894,7 @@ export declare type TivioReactBundle = {
     internal: TivioInternalBundle;
     analytics: TivioAnalytics;
     destroy: () => Promise<void>;
-} & Pick<TivioSetters, 'setBundleVersion' | 'setUser' | 'setLanguage' | 'setStorageManager'>;
+} & Pick<TivioSetters, 'setBundleVersion' | 'setUser' | 'setLanguage' | 'setStorageManager'> & Omit<Partial<TivioJsBundleExposedApi>, 'createPlayerWrapper'>;
 
 /**
  * @public