@tivio/sdk-react 4.5.0 → 5.0.0

package/dist/sdk-react.d.ts

@@ -1,5 +1,6 @@
 import { ComponentType } from 'react';
 import { FunctionComponentElement } from 'react';
+import { OperatingSystem } from 'detect-browser';
 import { default as React_2 } from 'react';
 
 /**
@@ -129,6 +130,15 @@ declare type AdSource_2 = SourceBase & {
     type: 'ad';
 };
 
+/**
+ * @public
+ */
+export declare interface Advertisement extends RowItem {
+    id: string;
+    itemType: ROW_ITEM_TYPES.ADVERTISEMENT;
+    type?: string | null;
+}
+
 /**
  * @public
  */
@@ -140,6 +150,63 @@ export declare enum ALGOLIA_INDEX_NAME {
     USERS = "users"
 }
 
+/**
+ * List of conversion types that we send to analytics.
+ */
+export declare enum AnalyticsConversionName {
+    CLICK = "click",
+    PLAY = "play",
+    PURCHASE = "purchase",
+    VISIT = "visit"
+}
+
+/**
+ * Map of Tivio targets in our apps.
+ * Values are based on url paths and rewrites from firebase.json
+ */
+export declare enum AnalyticsConversionPage {
+    Videos = "videos",
+    Series = "series",
+    Profile = "profile",
+    Tags = "tags",
+    Screens = "screens",
+    Registration = "registration",
+    Login = "login",
+    About = "about",
+    ResetPassword = "reset-password",
+    Player = "player",
+    Redeem = "redeem",
+    Referral = "referral",
+    Pair = "pair",
+    Search = "search"
+}
+
+/**
+ * For conversion purchases
+ */
+export declare enum AnalyticsConversionStatus {
+    SUCCESS = "SUCCESS",
+    FAILED = "FAILED"
+}
+
+export declare type AnalyticsConversionTarget = AnalyticsConversionTargetBase | AnalyticsConversionPage;
+
+export declare enum AnalyticsConversionTargetBase {
+    Element = "element",
+    Monetization = "monetization"
+}
+
+export declare interface AnalyticsInterface {
+    reportAdvertisementPlay: () => void;
+    reportAdvertisementProgress: () => void;
+    reportElementClick: (elementId: string) => void;
+    reportLocationChange: (path: string, pathParam?: string) => void;
+    createMonetizationPurchase: () => void;
+    completeMonetizationPurchase: (status: AnalyticsConversionStatus, monetizationId?: string) => void;
+    reportVideoPlay: (status: AnalyticsConversionStatus, videoId: string) => void;
+    reportVideoProgress: (videoId: string, videoDuration: number, checkpoint: number) => void;
+}
+
 /**
  * @public
  */
@@ -201,7 +268,6 @@ export declare type BannerProps = {
     focused: boolean;
     onClick?: () => void;
     hoverable: boolean;
-    broadcastInfo: string;
     height: number;
     cover: string;
     overlay: boolean;
@@ -355,6 +421,77 @@ export declare interface ConfirmationOverlayPayloadBase {
     automaticConfirmDelayMs?: number;
 }
 
+/**
+ * Entity aggregate conversion statistics per day
+ */
+export declare interface ConversionAnalytic {
+    /**
+     * Unix timestamp
+     */
+    date: number;
+    type: AnalyticsConversionName;
+    statistics: ConversionsItem[];
+}
+
+export declare interface ConversionsItem {
+    technology: PLATFORM;
+    os: DeviceOs;
+    osVersion: string;
+    details: {
+        /**
+         * Count of conversion with Success state
+         */
+        successCount: number;
+        /**
+         * Count of all conversion regardless of status
+         */
+        totalCount: number;
+        targets: ConversionsTargetItem[];
+    };
+}
+
+/**
+ * Entity with statistics conversion for url
+ */
+export declare interface ConversionsTargetItem {
+    /**
+     * Target id represent different values for every conversion.
+     * e.g. for visit conversion on video page saving videoId
+     * e.g. for visit conversion on profile page not saving anything
+     * e.g. for purchase conversion save monetizationId when user select specific monetization
+     * e.g. for purchase conversion not save anything when user leave monetization before select
+     * e.g. for click conversion save elementId
+     */
+    targetId: string;
+    /**
+     * Target type represent different values for every conversion.
+     * e.g. for visit conversion show current path
+     * e.g. for purchase conversion is every time monetization
+     * e.g. for click conversion is every time element
+     */
+    targetType: AnalyticsConversionTarget;
+    /**
+     * Path is page of conversion
+     * e.g. for visit conversion represent previews page
+     * e.g. for purchase conversion is page where purchase happened
+     * e.g. for click conversion is page where click happened
+     */
+    path: string;
+    /**
+     * Path param is param from url of conversion (e.g. video page -> videoId, profile page -> unknown)
+     * e.g. for visit conversion represent parameters previews page
+     * e.g. for purchase conversion where purchase happened
+     * e.g. for click conversion where click happened
+     */
+    pathParam: string | undefined;
+    /** Count of conversion with Success state on specific page */
+    successCount: number;
+    /**
+     * Count of all conversion regardless of status on specific page
+     */
+    totalCount: number;
+}
+
 /**
  * @public
  * @TODO move somewhere else
@@ -401,14 +538,20 @@ export declare type Currency = 'CZK' | 'EUR' | 'USD';
 /**
  * @public
  */
-export declare enum CUSTOMER_BUILD {
+export declare enum CustomerId {
     OKTAGON = "OKTAGON",
     JOJ = "JOJ",
     MALL = "MALL",
     GARAZ = "GARAZ",
     U_KULATEHO_STOLU = "U_KULATEHO_STOLU",
     INVESTOREES = "INVESTOREES",
-    DVTV = "DVTV"
+    DVTV = "DVTV",
+    DVTV_DEV = "DVTV_DEV",
+    O2 = "O2",
+    GRAPE = "GRAPE",
+    TIVIO = "TIVIO",
+    STORYBOOK = "STORYBOOK",
+    NANGU_DEV = "NANGU_DEV"
 }
 
 /**
@@ -559,6 +702,11 @@ export declare type DetailedPrice = {
  */
 export declare type DeviceInfo = ArrisDeviceInfo | ReactNativeDeviceInfo;
 
+/**
+ * @public
+ */
+export declare type DeviceOs = OperatingSystem | 'Tizen' | 'webOS' | 'Arris' | 'Android TV' | 'tvOS';
+
 /**
  * @public
  */
@@ -624,6 +772,7 @@ export declare type Events = {
  */
 export declare type ExternalTvConfig = {
     logo: string;
+    splashScreenBackgroundColor?: string;
 };
 
 /**
@@ -639,12 +788,32 @@ export declare const fetchBundle: (secret: string, conf: InternalConfig) => Prom
 declare type FetchPackage = (url: string) => Promise<string>;
 
 /**
+ * Counterpart for {@link ForbiddenError} from @tivio/api.
  * @public
  */
-export declare interface GenericOnCallError {
-    code: string;
-    message?: string;
-    details?: string[];
+export declare interface ForbiddenOnCallError extends GenericOnCallError {
+    code: 'permission-denied';
+    details?: {
+        reason: ForbiddenReason;
+    };
+}
+
+export declare enum ForbiddenReason {
+    MONETIZATION = "MONETIZATION",
+    GEO_BLOCKING = "GEO_BLOCKING"
+}
+
+/**
+ * On call error interface for front-end.
+ * Do not use it / throw it from @tivio/api.
+ * @public
+ */
+export declare interface GenericOnCallError extends Error {
+    /**
+     * Based on {@link FunctionsErrorCode} from firebase-functions.
+     */
+    code: 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';
+    details?: Record<string, string>;
 }
 
 /**
@@ -675,6 +844,57 @@ export declare type GetPurchaseInfoResponse = {
     };
 };
 
+export declare interface GetSourceUrlRequest {
+    /**
+     * Id of the document to return source for.
+     */
+    id: string;
+    /**
+     * Type of the document to return source for.
+     */
+    documentType: 'video' | 'tvChannel';
+    /**
+     * Which capabilities should the resulting source support.
+     */
+    capabilities: PlayerCapability[];
+    /**
+     * Which language the resulting source should support.
+     * If not present, language is not taken into consideration when picking the resulting source.
+     */
+    language?: LangCode;
+    /**
+     * Which sources did client (or cloud function) has already tried out.
+     */
+    sourceHistory?: string[];
+    /**
+     * When set to true the function will return urls with unsecured http protocol.
+     * We need this because some devices in certain circumstances are not able to use https.
+     *
+     * e.g. On LG it is not possible to use HTTPS certificates with root authority
+     * `Let's Encrypt` (for more info see https://jira.nangu.tv/browse/TIV-1047),
+     * which is used on cdn3.tiv.io domain.
+     *
+     * Switching this urls to http is a workaround for these cases.
+     */
+    preferHttp?: boolean;
+    /**
+     * If set to true, sources on the document will be skipped and function will try to
+     * construct sources based on source domains right away.
+     */
+    ignoreDocumentSources?: boolean;
+}
+
+export declare interface GetSourceUrlResponse {
+    /**
+     * The resulting source url.
+     */
+    url: string;
+    /**
+     * Which sources did client (or cloud function) has already tried out.
+     */
+    sourceHistory: string[];
+}
+
 /**
  * @public
  */
@@ -794,7 +1014,7 @@ export declare type ItemComponent = RowItemComponent | BannerItemComponent;
 /**
  * @public
  */
-export declare type ItemsInRow = Tag | Video | TvChannel;
+export declare type ItemsInRow = Tag | Video | TvChannel | Advertisement;
 
 /**
  * @public
@@ -939,6 +1159,14 @@ export declare interface Marker {
     type: 'AD' | 'AD_SEGMENT' | 'START' | 'END' | 'INTRO';
 }
 
+/**
+ * @public
+ */
+export declare type MarkersProps = {
+    color?: string;
+    className?: string;
+};
+
 /**
  * External information of video migrated via our Public API.
  * @public
@@ -1004,6 +1232,7 @@ export declare interface MonetizationsSelectOverlayData {
      * Otherwise, user is making a purchase for himself.
      */
     voucherPurchase?: boolean;
+    registrationRedirect?: boolean;
     onPurchase?: () => void;
     onClose?: () => void;
 }
@@ -1012,9 +1241,10 @@ export declare interface MonetizationsSelectOverlayData {
  * @public
  */
 export declare type MonetizationsSelectOverlayState = {
+    isOpen: boolean;
     data: MonetizationsSelectOverlayData | null;
-    closeMonetizationsSelectOverlay: () => void;
     openMonetizationsSelectOverlay: (data: MonetizationsSelectOverlayData) => void;
+    closeMonetizationsSelectOverlay: () => void;
 };
 
 /**
@@ -1115,12 +1345,16 @@ export declare type PaginationInterface<Entity> = {
 export declare type PaginationOptions = Partial<{
     limit: number;
     noLimit: boolean;
+    noAutoFetch: boolean;
 }>;
 
 /**
  * @public
  */
 export declare enum PLATFORM {
+    /**
+     * Includes tablets.
+     */
     MOBILE = "MOBILE",
     WEB = "WEB",
     TV = "TV"
@@ -1721,8 +1955,13 @@ export declare type ReactNativeDeviceInfo = {
     os?: 'iOS' | 'Android OS';
     osVersion: string;
     platform: PLATFORM;
+    isTablet?: boolean;
 };
 
+export declare enum RegistrationRedirect {
+    PAYMENT = "payment"
+}
+
 /**
  * @public
  */
@@ -1738,7 +1977,7 @@ export declare type RemoteBundleState = {
 export declare type RemoteProviderProps = {
     disableUnmounting?: boolean;
     language?: LangCode;
-    children: any;
+    children: React_2.ReactNode;
 };
 
 /**
@@ -1769,7 +2008,9 @@ export declare interface RouterOverrides {
         manual?: boolean;
         origin?: LoginRedirect;
     }) => void;
-    goToRegistrationPage: () => void;
+    goToRegistrationPage: (options?: {
+        origin?: RegistrationRedirect;
+    }) => void;
     goBack: () => void;
     goLivePlayer: (tvChannelId: string) => void;
     goVodPlayer: (videoIdOrUrlName: string) => void;
@@ -1783,6 +2024,7 @@ export declare interface RouterOverrides {
 export declare interface RouterOverridesContextState {
     routerOverrides: RouterOverrides;
     Link: React_2.ComponentType<{
+        children?: React_2.ReactNode;
         href?: string;
     }>;
 }
@@ -1798,7 +2040,8 @@ export declare type Row = RowStandard | RowBanner;
 export declare enum ROW_ITEM_TYPES {
     VIDEO = "VIDEO",
     TAG = "TAG",
-    TV_CHANNEL = "TV_CHANNEL"
+    TV_CHANNEL = "TV_CHANNEL",
+    ADVERTISEMENT = "ADVERTISEMENT"
 }
 
 /**
@@ -1859,7 +2102,8 @@ export declare interface RowItemAssets {
 export declare enum RowItemComponent {
     ROW_ITEM_PORTRAIT = "ROW_ITEM_PORTRAIT",
     ROW_ITEM_LANDSCAPE = "ROW_ITEM_LANDSCAPE",
-    ROW_ITEM_CIRCLED = "ROW_ITEM_CIRCLED"
+    ROW_ITEM_CIRCLED = "ROW_ITEM_CIRCLED",
+    ROW_ITEM_BANNER = "ROW_ITEM_BANNER"
 }
 
 /**
@@ -1934,7 +2178,7 @@ export declare type ScreenOptions = Partial<{
 /**
  * @public
  */
-export declare type ScreenRowType = 'filter' | 'custom' | 'continueToWatch' | 'favourites';
+export declare type ScreenRowType = 'filter' | 'custom' | 'continueToWatch' | 'favourites' | 'topWatched';
 
 /**
  * Listen to screen data
@@ -2000,7 +2244,7 @@ export declare interface SettingsItem {
  * Sign out - setUser(null)
  * @public
  */
-export declare const setUser: (userId: string | null, payload?: UserPayload | undefined) => Promise<void>;
+export declare const setUser: (userId: string | null, payload?: UserPayload) => Promise<void>;
 
 /**
  * @public
@@ -2181,6 +2425,7 @@ export declare type TileOptions = {
  * @public
  */
 export declare type TileProps = {
+    children?: React_2.ReactNode;
     cover: string;
     bottomLabel: string;
     bottomLabelAreaHeight: number;
@@ -2243,6 +2488,13 @@ export declare type TileSizesMap = {
  */
 export declare type TileSizeVariant = 'default' | 'mobile';
 
+/**
+ * @public
+ */
+export declare type TivioAnalytics = {
+    analytics: AnalyticsInterface;
+};
+
 /**
  * @public
  */
@@ -2282,8 +2534,10 @@ export declare type TivioBundleFile = {
  * @public
  */
 export declare type TivioComponents = {
-    Markers: React_2.ReactNode;
-    PlayerDataContext: React_2.ReactNode;
+    Markers: React_2.ComponentType<MarkersProps>;
+    PlayerDataContext: React_2.Context<{
+        player: any | null;
+    }>;
     Provider: React_2.ComponentType<RemoteProviderProps>;
     WebPlayer: React_2.ComponentType<WebPlayerProps>;
     Widget: React_2.ComponentType<TivioWidgetProps>;
@@ -2352,6 +2606,13 @@ export declare interface TivioConfig {
      */
     deviceInfo?: DeviceInfo;
     player?: PlayerConfig;
+    /**
+     * Used for purposes where we need to differentiate organizations before it is known based on secret and data from DB.
+     *
+     * At this time it is necessary only for LG builds because on LG TVs it is needed to separate apps indexedDB storages
+     * (otherwise organizations would share login token).
+     */
+    customerId?: CustomerId;
 }
 
 /**
@@ -2431,6 +2692,7 @@ export declare type TivioHooks = {
         applyInviteCode: (code: string) => void;
         inviteCodeReset: () => void;
     };
+    useChannelSource: UseChannelSource;
 };
 
 /**
@@ -2485,12 +2747,11 @@ export declare type TivioInternalHooks = {
             promotionId?: string;
             referralId: string;
             promotion?: any;
-        };
+        } | null;
         error: Error | null;
         loading: boolean;
     });
     useTvChannel: UseTvChannel;
-    useChannelSource: UseChannelSource;
     useUser: () => {
         user: User | null;
         error: string | null;
@@ -2506,15 +2767,19 @@ export declare type TivioInternalHooks = {
 export declare type TivioInternalProviders = {
     AppThemeProvider: React_2.ComponentType;
     CustomerProvider: React_2.ComponentType<{
-        customer: CUSTOMER_BUILD;
+        customer: CustomerId;
         platform: PLATFORM;
-        children: any;
+        children?: React_2.ReactNode;
+    }>;
+    ConfigProvider: React_2.ComponentType<React_2.PropsWithChildren>;
+    UserContextProvider: React_2.ComponentType<{
+        children?: React_2.ReactNode;
     }>;
-    ConfigProvider: React_2.ComponentType;
-    UserContextProvider: React_2.ComponentType;
     MonetizationsSelectOverlayContextProvider: React_2.ComponentType;
     QerkoOverlayContextProvider: React_2.ComponentType;
-    PurchasesWithVideosContextProvider: React_2.ComponentType;
+    PurchasesWithVideosContextProvider: React_2.ComponentType<{
+        children?: React_2.ReactNode;
+    }>;
     /**
      * @deprecated not used in our app, can be removed when no sdk in production uses it
      */
@@ -2619,6 +2884,7 @@ export declare type TivioReactBundle = {
      * TODO should not be the part of public API
      */
     internal: TivioInternalBundle;
+    analytics: TivioAnalytics;
     destroy: () => Promise<void>;
 } & Pick<TivioSetters, 'setBundleVersion' | 'setUser' | 'setLanguage' | 'setStorageManager'>;
 
@@ -2680,7 +2946,7 @@ export declare type TivioVodSource = SourceBase & StartAndContinuePosition & {
 /**
  * @public
  */
-export declare const TivioWidget: React_2.ForwardRefExoticComponent<Pick<TivioWidgetProps, "id" | "onEnabled" | "onBlur"> & React_2.RefAttributes<TivioWidgetRef>>;
+export declare const TivioWidget: React_2.ForwardRefExoticComponent<Omit<TivioWidgetProps, "ref"> & React_2.RefAttributes<TivioWidgetRef>>;
 
 /**
  * @public
@@ -2746,7 +3012,7 @@ export declare type Translation = {
  * @public
  */
 export declare type TvAppProps = {
-    customer: CUSTOMER_BUILD;
+    customer: CustomerId;
 };
 
 /**
@@ -2767,10 +3033,12 @@ export declare interface TvChannel extends RowItem {
      * Transactions before subscriptions, sorted by price ascending.
      */
     getPurchasableMonetizations(options?: GetPurchasableMonetizationsOptions): PurchasableMonetization[];
+    getSourceUrl(fallbackUrl?: string): Promise<GetSourceUrlResponse>;
     purchasableMonetization: any | null;
     price: number;
     cover: string;
     isPlayable: boolean;
+    uri: string;
 }
 
 /**
@@ -2924,7 +3192,7 @@ export declare const useMarkers: () => Marker[] | null;
 /**
  * @public
  */
-export declare const useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean | undefined) => {
+export declare const useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean) => {
     subscriptions: PurchasableMonetization[];
 };
 
@@ -2957,7 +3225,7 @@ export declare function usePurchaseRecovery(): {
 /**
  * @public
  */
-export declare const usePurchaseSubscription: (monetizationId: string, voucher?: NewVoucher | undefined) => QerkoTransaction;
+export declare const usePurchaseSubscription: (monetizationId: string, voucher?: NewVoucher) => QerkoTransaction;
 
 /**
  * Return purchases with initialized video (purchases[i].video not null)
@@ -3006,6 +3274,7 @@ export declare type User = {
     profiles: any[];
     activeUserProfileId: string | null;
     createUserProfile: (request: any) => Promise<void>;
+    deleteUserProfile: (profileId: string) => Promise<void>;
     setActiveUserProfileId: (id: string) => void;
 };
 
@@ -3101,7 +3370,7 @@ export declare const useTivioReadyData: () => RemoteBundleState | null;
 /**
  * @public
  */
-export declare const useTransactionPayment: (videoId: string, monetizationId: string, voucher?: NewVoucher | undefined) => QerkoTransaction;
+export declare const useTransactionPayment: (videoId: string, monetizationId: string, voucher?: NewVoucher) => QerkoTransaction;
 
 /**
  * @public
@@ -3127,7 +3396,7 @@ export declare const useUser: () => {
  * @param videoIdOrUrlName - video id or video nice url (e.g. some-interesting-video)
  * @public
  */
-export declare const useVideo: (videoIdOrUrlName?: string | undefined) => {
+export declare const useVideo: (videoIdOrUrlName?: string) => {
     data: Video | null;
     error: string | null;
 };
@@ -3160,15 +3429,7 @@ export declare const useWatchWithoutAdsOffer: () => {
 /**
  * @public
  */
-export declare const VAST_PROVIDERS: ({
-    id: VastProvider;
-    name: string;
-    development?: undefined;
-} | {
-    id: VastProvider;
-    name: string;
-    development: boolean;
-})[];
+export declare const VAST_PROVIDERS: VastProvidersItem[];
 
 /**
  * @public
@@ -3190,11 +3451,18 @@ export declare enum VastProvider {
     PRIMA = "prima",
     TEST = "test",
     TEST_VPAID = "test-vpaid",
+    TIVIO_ADS = "tivio-ads",
     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"
 }
 
+declare type VastProvidersItem = {
+    id: VastProvider;
+    name: string;
+    development?: boolean;
+};
+
 /**
  * @public
  */
@@ -3221,6 +3489,7 @@ export declare interface Video extends RowItem {
      * Transactions before subscriptions, sorted by price ascending.
      */
     getPurchasableMonetizations(options?: GetPurchasableMonetizationsOptions): PurchasableMonetization[];
+    getSourceUrl(fallbackUrl?: string): Promise<GetSourceUrlResponse>;
     purchasableMonetization: any | null;
     transaction: PurchasableMonetization | undefined;
     subscriptions: PurchasableMonetization[];
@@ -3252,6 +3521,8 @@ export declare interface Video extends RowItem {
     addToFavorites: () => void;
     removeFromFavorites: () => void;
     availability: VideoAvailability | null;
+    sourceLanguages: LangCode[];
+    uriByLanguage: (lang: LangCode) => string | undefined;
 }
 
 /**
@@ -3432,7 +3703,7 @@ export declare type WebRowProps = {
     variant?: RowItemComponent;
     rowName?: string | any;
     fetchMore?: () => void;
-    onTileClick?: (item: ItemsInRow) => void;
+    onTileClick?: (item?: ItemsInRow | null) => void;
 };
 
 /**
@@ -3476,6 +3747,6 @@ export declare type Widget = {
 /**
  * @public
  */
-export declare function withPlayerContext(id: string): <P>(WrappedComponent: React_2.ComponentType<P>) => (props: P) => JSX.Element;
+export declare function withPlayerContext(id: string): <P extends JSX.IntrinsicAttributes>(WrappedComponent: React_2.ComponentType<P>) => (props: P) => JSX.Element;
 
 export { }