@tivio/sdk-react 4.0.0 → 4.0.1

package/dist/index.d.ts

@@ -37,6 +37,27 @@ export declare interface AdExternal {
     skip: () => void;
 }
 
+/**
+ * @public
+ */
+export declare type AdMetadata = {
+    type: 'ad';
+    subType: 'inserted' | 'original';
+    secondsToEnd: number;
+    /**
+     * null when ad is not skippable
+     */
+    secondsToSkippable: number | null;
+    canTriggerSkip: boolean;
+    isSkippable: boolean;
+    order: number | null;
+    totalCount: number | null;
+    skip: () => void;
+} | null;
+
+/**
+ * @public
+ */
 declare type AdSegment = {
     id: string;
     /**
@@ -95,6 +116,13 @@ export declare type AdSource = {
     secondsToSkippable: number | null;
 };
 
+/**
+ * @public
+ */
+declare type AdSource_2 = SourceBase & {
+    type: 'ad';
+};
+
 /**
  * @public
  */
@@ -193,11 +221,7 @@ export declare type BannerProps = {
     hoverable: boolean;
     broadcastInfo: string;
     height: number;
-    coverPadding: CoverPadding;
     cover: string;
-    fullWidth: boolean;
-    coverContainerPaddingTop: string;
-    width: number;
     overlay: boolean;
     price: string;
     hasRoundCorners: boolean;
@@ -248,9 +272,6 @@ export declare interface Channel {
     recentVideos: Video[];
 }
 
-/**
- * @public
- */
 export declare type ChannelSource = {
     new (uri: string, originalOptions: Record<string, any>, channelName: string, programName: string, programDescription: string, from: Date, to: Date): ChannelSource;
     description: string;
@@ -375,7 +396,7 @@ export declare type DetailedPrice = {
 /**
  * @public
  */
-export declare type DeviceInfo = ArrisDeviceInfo | WebosDeviceInfo | TizenDeviceInfo;
+export declare type DeviceInfo = ArrisDeviceInfo | ReactNativeDeviceInfo;
 
 /**
  * @public
@@ -408,6 +429,11 @@ export declare type DocumentOptions = Partial<{
  */
 export declare type Empty = void | Promise<void> | undefined | Promise<undefined>;
 
+/**
+ * @public
+ */
+declare type Empty_2 = void | Promise<void> | undefined | Promise<undefined>;
+
 /**
  * @public
  */
@@ -521,7 +547,7 @@ export declare type InternalConfig = SdkReactConfig & {
     fetchPackage: FetchPackage;
     pubSub: PubSub;
     /**
-     * @private URL of resolver. Resolver is a script used to fetch remove code bundle
+     * @private URL of resolver. Resolver is a script used to fetch remote code bundle
      */
     resolverUrl: string;
     sdkVersion: string;
@@ -558,6 +584,24 @@ declare interface IntroMarker {
  */
 export declare type ItemsInRow = Tag | Video | TvChannel;
 
+/**
+ * @public
+ */
+export declare interface JojExternals {
+    tvProfiProgramId?: string;
+    tvProfiContentId?: string;
+    tvProfiSerialId?: string;
+    contentId?: string;
+    provysId?: string;
+    tvProfiProvysId?: string;
+    tvProfiHouseId?: string;
+    tvProfiTitleOriginal?: string;
+    tvProfiTitleSk?: string;
+    tvProfiType?: string;
+    tvProfiSeriesName?: string;
+    tvProfiDistributor?: string;
+}
+
 /**
  * Enum of all supported languages codes as in ISO 639-1
  * @public
@@ -592,6 +636,34 @@ export declare type LinkedVideo = {
     type: 'CUT' | 'TRAILER' | 'BONUS' | 'CHILD';
 };
 
+/**
+ * @public
+ */
+export declare type Listener = ListenerAdMetadata | ListenerMarkers;
+
+/**
+ * @public
+ */
+export declare type ListenerAdMetadata = (metadata: AdMetadata) => void;
+
+/**
+ * @public
+ */
+export declare type ListenerMarkers = (marker: Marker[] | null) => void;
+
+/**
+ * Not supported yet, now it does pass-through only.
+ *
+ * @public
+ */
+export declare type LiveTvChannelSource = SourceBase & {
+    type: 'live_tv_channel';
+    /**
+     * Tivio needs channel name in order to load markers.
+     */
+    channelName: string;
+};
+
 declare interface Logger {
     /** important messages */
     warn(...data: LoggerArgs): void;
@@ -614,15 +686,24 @@ declare type LoggerArgs = any[];
 /**
  * @public
  */
-export declare type Marker = {
+export declare interface MallTvExternals {
+    mallTvEntityId: string;
+}
+
+/**
+ * @public
+ */
+export declare interface Marker {
     id: string;
-    type: string;
     from: Date;
     to: Date;
     count?: number;
     fromMs?: number;
     toMs?: number;
-};
+    relativeFromMs: number;
+    relativeToMs: number;
+    type: 'AD' | 'AD_SEGMENT' | 'START' | 'END' | 'INTRO';
+}
 
 /**
  * @public
@@ -678,6 +759,16 @@ export declare type Nullable<T> = {
  */
 export declare type ObjectType = Record<string, any>;
 
+/**
+ * @public
+ */
+export declare interface OktagonExternals {
+    /**
+     * DRM content Key ID - shouldn't be more connected with buyDRM or streamOnline? It is not general thing
+     */
+    keyId?: string;
+}
+
 /**
  * @public
  */
@@ -694,6 +785,16 @@ declare type OrderByDirection = 'desc' | 'asc';
 export declare interface Organization {
 }
 
+/**
+ * If Tivio PlayerWrapper is an interception layer, it should allow the pass-through
+ * of not just Tivio source types but any other source types that the 3rd party app may be using.
+ *
+ * @public
+ */
+export declare type OtherSource = SourceBase & StartAndContinuePosition & {
+    type: 'other';
+};
+
 /**
  * @public
  */
@@ -721,6 +822,30 @@ export declare enum PLATFORM {
     TV = "TV"
 }
 
+/**
+ * @public
+ */
+export declare type Player = {
+    ad: any;
+    currentTime: any;
+    adSegment: any;
+    event: any;
+    events: any;
+    source: any;
+    state: any;
+    onPlaybackEnded: any;
+    onSourceChanged: any;
+    onStateChanged: any;
+    onTimeChanged: any;
+    pause: any;
+    play: any;
+    togglePlayPause: any;
+    register: any;
+    seekTo: any;
+    setVolume: any;
+    triggerEvent: any;
+};
+
 /**
  * @public
  */
@@ -776,6 +901,17 @@ export declare type PlayerConfig = {
             fullFileDownloadSupport?: boolean;
         };
     };
+    /**
+     * Ad service settings
+     */
+    adService?: {
+        /**
+         * Tivio - can be used in websites and TV apps. Does not support VPAID
+         * IMA - can be used only in websites. Supports VAST 2, partially VAST 3, VAST 4, SIMID 1.0, OM SDK 1.3,
+         *   VPAID 2 (HTML5) https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/compatibility
+         */
+        name: 'IMA SDK' | 'Tivio';
+    };
 };
 
 /**
@@ -810,6 +946,18 @@ export declare interface PlayerInterface {
     unmute?: () => void;
 }
 
+/**
+ * @public
+ */
+export declare interface PlayerInterfaceForPlayerWrapper {
+    /**
+     * @param {number} ms - milliseconds relative to start of video (relative to 0 ms)
+     *  or in case of TV programs relative to start of the program (relative to source.from ms)
+     */
+    seekTo: (ms: number) => void;
+    setSource: (source: Source | null) => void;
+}
+
 /**
  * @public
  */
@@ -867,8 +1015,8 @@ export declare type PlayerWrapper = {
     source: InputSource | null;
     events: {
         isSupported: (even: string) => boolean;
-        addListener: <T = any>(event: string, cb: (value: T) => Empty) => void;
-        removeListener: <T = any>(event: string, cb: (value: T) => Empty) => void;
+        addListener: <T = any>(event: string, cb: (value: T) => Empty_2) => void;
+        removeListener: <T = any>(event: string, cb: (value: T) => Empty_2) => void;
         removeAllListeners: () => void;
     };
     /**
@@ -906,6 +1054,19 @@ export declare type PlayerWrapper = {
     toggleMuted: () => void;
 };
 
+/**
+ * @public
+ */
+export declare enum PlayerWrapperEventType {
+    adMetadata = "adMetadata",
+    markers = "markers"
+}
+
+/**
+ * @public
+ */
+export declare type PlayerWrapperEventTypeType = `${PlayerWrapperEventType}`;
+
 /**
  * @public
  */
@@ -925,12 +1086,16 @@ export declare type Purchase = {
     expirationDate: Date | null;
     id: string;
     isExpired: boolean;
+    /**
+     * @deprecated isPurchased is ambiguous name. Now it means that purchase.status is "PAID".
+     * So use purchase.status === PurchaseStatus.PAID instead.
+     */
     isPurchased: boolean;
     monetization: PurchaseMonetization | null;
     monetizationId: string | null;
     monetizationRef: any | null;
     status: PurchaseStatus | null;
-    type: MonetizationType | null;
+    type: PurchaseType | null;
     /**
      * Timestamp of the last purchase status update in milliseconds.
      */
@@ -948,7 +1113,10 @@ export declare type PurchaseMonetization = {
     currency?: Currency;
     period?: number;
     price?: number;
-    type: MonetizationType;
+    /**
+     * Here are only transaction and subscription, because purchasing of advertisement monetization doesn't make sense.
+     */
+    type: 'transaction' | 'subscription';
     title?: string;
     frequency?: MONETIZATION_FREQUENCY | null;
     /**
@@ -969,9 +1137,16 @@ export declare enum PurchaseStatus {
     /**
      * Used when purchase is terminated due to terms and conditions violation (e.g. restreaming).
      */
-    KILL = "KILL"
+    BLOCKED = "BLOCKED"
 }
 
+/**
+ * Purchase is a purchase of one video (transaction type), purchase of subscription or voucher.
+ *
+ * @public
+ */
+export declare type PurchaseType = 'transaction' | 'subscription' | 'voucher';
+
 /**
  * @public
  */
@@ -985,7 +1160,7 @@ export declare interface QerkoCancellationInfo {
  */
 export declare interface QerkoData {
     monetization: Monetization;
-    video?: Video;
+    item?: Video | TvChannel;
     onPurchase?: () => void;
     onClose?: () => void;
 }
@@ -1038,6 +1213,19 @@ export declare interface QerkoTransaction {
     voucherId?: string;
 }
 
+/**
+ * @public
+ */
+export declare type ReactNativeDeviceInfo = {
+    type: 'react-native';
+    /**
+     * Type values defined according to {@link OperatingSystem} from `detect-browser` package for convenience.
+     */
+    os?: 'iOS' | 'Android OS';
+    osVersion: string;
+    platform: PLATFORM;
+};
+
 /**
  * @public
  */
@@ -1052,7 +1240,7 @@ export declare type RemoteBundleState = {
  */
 export declare type RemoteProviderProps = {
     disableUnmounting?: boolean;
-    language?: string;
+    language?: LangCode;
     children: any;
 };
 
@@ -1126,6 +1314,7 @@ export declare interface RowItemAssets {
     portrait?: string | null;
     circled?: string | null;
     banner?: string | null;
+    bannerMobile?: string | null;
 }
 
 /**
@@ -1213,7 +1402,7 @@ export declare type ScreenSubscription = (screenId: string, cb: (error: Error |
  *
  * @public
  */
-export declare type SdkReactConfig = Omit<TivioConfig, 'deviceCapabilities' | 'language'> & {
+export declare type SdkReactConfig = Omit<TivioConfig, 'language'> & {
     disableUnmounting?: boolean;
     enable?: boolean;
     enableSentry?: boolean;
@@ -1222,7 +1411,9 @@ export declare type SdkReactConfig = Omit<TivioConfig, 'deviceCapabilities' | 'l
     }>;
     LoaderComponent?: ComponentType;
     logger?: Logger | null;
-    deviceCapabilities: PlayerCapability[] | 'auto';
+    /**
+     * language is required for bundle init (TivioConfig), but it can be set to default EN on SDK side, so here it's optional.
+     */
     language?: LangCode;
 };
 
@@ -1261,6 +1452,63 @@ export declare const setUser: (userId: string | null, payload?: UserPayload | un
  */
 export declare const showGdprConsentPreferences: () => Promise<void>;
 
+/**
+ * @public
+ */
+export declare type Source = TvProgramSource | TivioVodSource | AdSource_2 | OtherSource | LiveTvChannelSource;
+
+/**
+ * @public
+ */
+export declare type SourceBase = {
+    /**
+     * Tivio SDK users may use pretty complicated source objects in their existing code and if Tivio player
+     * is an interception layer, it should allow them to pass through any type of object.
+     */
+    additionalPayload?: Record<string, any>;
+    /**
+     * Source type.
+     */
+    type: 'ad' | 'live_tv_channel' | 'other' | 'tivio_vod' | 'tv_program';
+    /**
+     * URI to play.
+     */
+    uri: string;
+};
+
+/**
+ * @public
+ */
+export declare type StartAndContinuePosition = {
+    /**
+     * Relative from stream start, in ms.
+     *
+     * On input to Tivio either `startFromPosition` or `continueFromPosition` must always be provided.
+     *
+     * On output from Tivio it is always defined. Tivio can change this value.
+     * (e.g. in order to fix start position of a TV program)
+     */
+    startFromPosition?: number;
+    /**
+     * Relative from stream start, in ms.
+     *
+     * On input to Tivio either `startFromPosition` or `continueFromPosition` must always be provided.
+     *
+     * If provided, tivio will not correct it and will send this value back in startFromPosition.
+     * If provided, startFromPosition is ignored.
+     */
+    continueFromPosition?: number;
+};
+
+/**
+ * @public
+ */
+declare interface StorageManager_2 {
+    getItem(key: string): string | null | Promise<string | null>;
+    setItem(key: string, value: string): void | Promise<void>;
+}
+export { StorageManager_2 as StorageManager }
+
 /**
  * @public
  */
@@ -1360,7 +1608,6 @@ export declare type TaggedVideosOrderByField = 'seasonNumber' | 'episodeNumber'
  */
 export declare type TileProps = {
     cover: string;
-    isLoading: boolean;
     bottomLabel: string;
     bottomLabelAreaHeight: number;
     innerLabel: string;
@@ -1369,7 +1616,6 @@ export declare type TileProps = {
     focused: boolean;
     onClick?: () => void;
     hoverable: boolean;
-    overlay: boolean;
     coverPadding: CoverPadding;
     variant: RowItemComponent;
     coverWidth: number;
@@ -1458,10 +1704,6 @@ export declare type TivioComponents = {
     WebTile: React_2.ComponentType<{
         item?: ItemsInRow;
     } & TilePropsPartial>;
-    AdIndicationButtonWeb: React_2.ReactNode;
-    Recommendation: React_2.ReactNode;
-    SkipButtonWeb: React_2.ReactNode;
-    TvPlayer: React_2.ComponentType<WebPlayerProps>;
 };
 
 /**
@@ -1520,7 +1762,7 @@ export declare type TivioGetters = {
      */
     getPlayerWrapper: (opt: {
         playerWrapperId?: string;
-    }) => any;
+    }) => PlayerWrapper;
     getOrganizationSubscriptions: () => Promise<Monetization[] | undefined>;
     /**
      * Get video by its id.
@@ -1539,7 +1781,7 @@ export declare type TivioGetters = {
  * @public
  */
 export declare type TivioHooks = {
-    useAd: () => [(AdSource | null)];
+    useAd: () => [(AdExternal | null)];
     useAdSegment: () => AdSegment | null;
     useCancelSubscription: UseCancelSubscription;
     useItemsInRow: (rowId: string, options: PaginationOptions) => {
@@ -1650,6 +1892,51 @@ export declare type TivioInternalProviders = {
     RouterOverridesContextProvider: React_2.ComponentType<RouterOverridesContextState>;
 };
 
+/**
+ * @public
+ */
+export declare type TivioJsBundleExposedApi = {
+    AdSource: any;
+    ChannelSource: any;
+    VodTivioSource: any;
+    /**
+     * Get (or create) player wrapper instance
+     * @param id - player wrapper id
+     * @returns {Player} player wrapper instance
+     */
+    getPlayer: (id: string) => Player;
+    /**
+     * Get tv channel by its id.
+     * @param tvChannelId - tv channel id
+     * @returns {Promise<TvChannel | null>} channel or null if tv channel does not exists
+     */
+    getTvChannelById: (tvChannelId: string) => Promise<TvChannel | null>;
+    /**
+     * Get tag by its id.
+     * @param tagId - tag id
+     * @returns {Promise<Tag | null>} widget or null if tag does not exists
+     */
+    getTagById: (tagId: string) => Promise<Tag | null>;
+    createPlayerWrapper: (playerImplementation: PlayerInterfaceForPlayerWrapper) => TivioPlayerWrapper;
+    destroy: () => Promise<void>;
+} & Pick<TivioGetters, 'getVideoById'> & Pick<TivioSubscriptions, 'subscribeToVideo' | 'subscribeToItemsInRow'> & Pick<TivioAuth, 'createUserWithEmailAndPassword' | 'signInWithEmailAndPassword'> & Pick<TivioSetters, 'setBundleVersion' | 'setUser' | 'setLanguage' | 'setStorageManager'>;
+
+/**
+ * @public
+ */
+export declare interface TivioPlayerWrapper {
+    addEventListener: (eventType: PlayerWrapperEventTypeType, listener: Listener) => void;
+    reportError: (error: Error) => void;
+    reportPlaybackEnded: () => void;
+    reportTimeProgress: (ms: number) => void;
+    seekTo: (ms: number) => void;
+    /**
+     * @param {Source} source - source to set
+     * @param {string} calibrationId - id of calibration profile
+     */
+    setSource: (source: Source | null, calibrationId?: string) => void;
+}
+
 /**
  * @public
  */
@@ -1684,12 +1971,6 @@ export declare type TivioReactBundle = {
         expirationDate: Date;
     }) => Promise<QerkoPaymentInfo>;
     cancelSubscriptionWithQerko: (subscriptionId: string) => Promise<QerkoCancellationInfo>;
-    /**
-     * Set tivio language.
-     * @param language
-     */
-    setLanguage: (language: LangCode) => void;
-    setUser: (userId: string | null, userPayload?: UserPayload) => Promise<void>;
     showConsentPreferences: () => void;
     /**
      * Contains hooks and providers for internal usages.
@@ -1698,6 +1979,20 @@ export declare type TivioReactBundle = {
      */
     internal: TivioInternalBundle;
     destroy: () => Promise<void>;
+} & Pick<TivioSetters, 'setBundleVersion' | 'setUser' | 'setLanguage' | 'setStorageManager'>;
+
+/**
+ * @public
+ */
+export declare type TivioSetters = {
+    setBundleVersion: (bundleVersion: string | null) => void;
+    /**
+     * Set tivio language.
+     * @param language
+     */
+    setLanguage: (language: LangCode) => void;
+    setStorageManager: (storageManager: StorageManager_2) => void;
+    setUser: (userId: string | null, userPayload?: UserPayload) => Promise<void>;
 };
 
 /**
@@ -1730,6 +2025,17 @@ export declare type TivioSubscriptions = {
     }) => void;
 };
 
+/**
+ * @public
+ */
+export declare type TivioVodSource = SourceBase & StartAndContinuePosition & {
+    type: 'tivio_vod';
+    /**
+     * Allows Tivio to load monetization config an apply ads.
+     */
+    videoPath: string;
+};
+
 /**
  * @public
  */
@@ -1779,15 +2085,6 @@ export declare interface TivioWidgetRef {
     });
 }
 
-/**
- * @public
- */
-export declare type TizenDeviceInfo = {
-    type: 'tizen';
-    model?: string;
-    osVersion?: string;
-};
-
 declare type TransactionInfo = {
     type: 'transaction';
     name: string;
@@ -1828,6 +2125,35 @@ export declare interface TvChannel extends RowItem {
     price: number;
 }
 
+/**
+ * @public
+ */
+export declare type TvProgramSource = SourceBase & StartAndContinuePosition & {
+    type: 'tv_program';
+    /**
+     * If epgTo is wrong, Tivio cannot correctly guess if the video it startover or timeshift . For such cases
+     * Tivio needs explicit tv mode.
+     * null if source begins in the future.
+     */
+    tvMode: 'startover' | 'timeshift' | null;
+    /**
+     * Tivio needs channel name in order to load markers.
+     */
+    channelName: string;
+    /**
+     * Tivio needs EPG from in order to load markers.
+     */
+    epgFrom: Date;
+    /**
+     * Tivio needs EPG to in order to load markers.
+     */
+    epgTo: Date;
+    /**
+     * When the stream (provided in uri) really starts - typically few minutes before epgFrom.
+     */
+    streamStart: Date;
+};
+
 /**
  * @public
  */
@@ -1836,7 +2162,7 @@ export declare const TvTivioProvider: React_2.FC<TivioProviderProps>;
 /**
  * @public
  */
-export declare const useAd: () => AdSource | null;
+export declare const useAd: () => AdExternal | null;
 
 /**
  * @public
@@ -1988,9 +2314,23 @@ export declare const usePurchasesWithVideos: () => {
  * @public
  */
 export declare type User = {
+    /**
+     * Returns "active" (non-expired) purchases, so they give access to some content.
+     * Does not return voucher purchases, because they give access to videos/subscriptions only for user who activates voucher,
+     * not for user who purchases it.
+     */
     purchases: Purchase[];
+    /**
+     * Returns all PAID or CANCELLED user purchases (expired and non-expired)
+     */
     allPurchases: Purchase[];
+    /**
+     * Returns "active" (not CANCELLED) VoD purchases ("transaction" type)
+     */
     purchasedVods: Purchase[];
+    /**
+     * Returns "active" (non-expired) subscription purchases
+     */
     purchasedSubscriptions: Purchase[];
     isPurchasesInitialized: boolean;
     isSignedIn: boolean;
@@ -2167,7 +2507,8 @@ export declare enum VastProvider {
     MALL_TV = "malltv",
     MALL_TV_PREBID = "malltv-prebid",
     PRIMA = "prima",
-    TEST = "test"
+    TEST = "test",
+    TEST_VPAID = "test-vpaid"
 }
 
 /**
@@ -2249,18 +2590,7 @@ export declare enum VideoContentType {
 /**
  * @public
  */
-export declare interface VideoExternals {
-    tvProfiProgramId?: string;
-    tvProfiContentId?: string;
-    tvProfiSerialId?: string;
-    contentId?: string;
-    provysId?: string;
-    mallTvEntityId?: string;
-    /**
-     * DRM content Key ID - should't be more connected with buyDRM or streamOnline? It is not general thing
-     */
-    keyId?: string;
-}
+export declare type VideoExternals = JojExternals | MallTvExternals | OktagonExternals;
 
 declare type VideoPath = string;
 
@@ -2277,7 +2607,11 @@ export declare enum VideoType {
      * Video is a standard single video.
      */
     VIDEO = "VIDEO",
-    TV_PROGRAM = "TV_PROGRAM"
+    TV_PROGRAM = "TV_PROGRAM",
+    /**
+     * Video object represents whole series, e.g. tv show.
+     */
+    SERIES = "SERIES"
 }
 
 /**
@@ -2324,15 +2658,6 @@ declare type Voucher = {
     voucherInfo: SubscriptionInfo | TransactionInfo;
 };
 
-/**
- * @public
- */
-export declare type WebosDeviceInfo = {
-    type: 'webos';
-    model?: string;
-    osVersion?: string;
-};
-
 /**
  * @public
  */