@tivio/sdk-react 3.5.2 → 3.6.0

package/dist/types/bundle.types.d.ts

@@ -1,444 +0,0 @@
-import { Currency, ItemsInRow, PaginationInterface, PaginationOptions, QerkoCancellationInfo, Row, SubscribeToItemsInRowOptions, SubscribeToTaggedVideos, Tag, TilePropsPartial, UseCancelSubscription, CUSTOMER_BUILD, PLATFORM, WebRowProps, WebSeriesDetailScreenProps, AuthOverlayState, CreateUserWithEmailAndPassword, UseChannelSource } from '@tivio/common';
-import { ComponentType } from 'react';
-import { Logger } from '../services/logger';
-import { FetchPackage } from '../services/packageLoader';
-import { Disposer, Empty, Nullable } from './common';
-import { Channel, LangCode, RemoteProviderProps, Section, TivioSources, TivioWidgetProps, WebPlayerProps, Widget } from './types';
-import type { AdSource, PlayerWrapper } from './customPlayer.types';
-import type { Monetization, Purchase, QerkoPaymentInfo, Screen, SubscribeToItemsInRow, SubscribeToRowsInScreen, SubscribeToScreen, TvAppProps, User, UseSearch, UseTvChannel, Video } from '@tivio/common';
-import type React from 'react';
-declare type Settings = {
-    /**
-     * @deprecated TIV-994 in favour of setUser from libs/sdk-react/src/services/login.ts
-     */
-    setUser: (userId: string, userPayload: unknown) => Promise<void>;
-};
-interface PlayerCapability {
-    codec: 'h264' | 'h265';
-    encryption: 'fairplay' | 'none' | 'playready' | 'widevine';
-    protocol: 'dash' | 'hls';
-}
-declare type InternalConfig = {
-    /**
-     * @private URL of remote code bundle to be fetched directly (without using resolver)
-     */
-    bundleUrlOverride?: string;
-    currency: Currency;
-    /**
-     * Tells Tivio which technologies/protocols etc. is the device capable to play.
-     * If not provided, Tivio will try to guess it (based on the browser).
-     */
-    deviceCapabilities: PlayerCapability[];
-    /**
-     * Additional options for deviceCapabilities
-     */
-    capabilitiesOptions?: {
-        /**
-         * Should the player prefer HTTP sources instead HTTPs if they are available.
-         * This can be used on platforms that support mixed content but do not support
-         * specific HTTPS certificates. (e.g. certificates from Letsencrypt not supported on LG TVs)
-         */
-        preferHttp?: boolean;
-    };
-    disableUnmounting?: boolean;
-    enable?: boolean;
-    enableSentry?: boolean;
-    ErrorComponent?: ComponentType<{
-        error: string | null;
-    }>;
-    fetchPackage: FetchPackage;
-    language?: LangCode;
-    LoaderComponent?: ComponentType;
-    logger?: Logger | null;
-    pubSub: PubSub;
-    /**
-     * @private URL of resolver. Resolver is a script used to fetch remove code bundle
-     */
-    resolverUrl: string;
-    sdkVersion: string;
-    secret: string | null;
-    verbose?: boolean;
-    /**
-     * @private
-     */
-    forceCloudFnResolver?: boolean;
-};
-declare type Events = {
-    'on-ready': RemoteBundleState;
-    'on-error': Error;
-};
-interface PubSub {
-    publish: <K extends keyof Events>(triggerName: K, payload: Events[K]) => Empty;
-    subscribe: <K extends keyof Events>(triggerName: K, onMessage: (data: Events[K]) => Empty) => Disposer;
-}
-export interface GenericOnCallError {
-    code: string;
-    message?: string;
-    details?: string[];
-}
-declare type Config = Pick<InternalConfig, 'bundleUrlOverride' | 'currency' | 'disableUnmounting' | 'capabilitiesOptions' | 'enable' | 'enableSentry' | 'ErrorComponent' | 'language' | 'LoaderComponent' | 'logger' | 'secret' | 'verbose' | 'forceCloudFnResolver'> & {
-    deviceCapabilities: PlayerCapability[] | 'auto';
-    /**
-     * @private
-     * Run HTML, CSS and JS feature support check
-     */
-    runFeatureSupportCheck?: boolean;
-};
-declare type TivioSubscriptions = {
-    subscribeToUser: (cb: (error: string | null, user: User | null) => void) => void;
-    /**
-     * Listen to widget changes.
-     * @param widgetId - widget id
-     * @param cb - callback on widget updates or on error
-     */
-    subscribeToWidget: (widgetId: string, cb: (error: Error | null, data: Widget | null, disposer?: Disposer) => void) => void;
-    /**
-     * Listen to channel changes.
-     * @param channelId - channel id
-     * @param cb - callback on channel updates or on error
-     */
-    subscribeToChannel: (channelId: string, cb: (error: Error | null, data: Channel | null) => void) => void;
-    /**
-     * Listen to section changes.
-     * @param sectionId - section id
-     * @param cb - callback on section updates or on error
-     */
-    subscribeToSection: (sectionId: string, cb: (error: Error | null, data: Section | null) => void) => void;
-    /**
-     * Listen to video changes.
-     * @param videoId - video id
-     * @param cb - callback on video updates or on error
-     */
-    subscribeToVideo: (videoId: string, cb: (error: Error | null, data: Video | null, disposer?: Disposer) => void) => void;
-    /**
-     * Listen to videos in section changes.
-     * @param sectionId - section id
-     * @param cb - callback on videos change or error
-     * @param limit - videos count
-     */
-    subscribeToVideosInSection: (sectionId: string, cb: (error: null | Error, data: null | {
-        videos: Video[];
-        hasNextPage: boolean;
-    }, fetchMore: null | ((count?: number) => void), isLoading: boolean) => void, limit?: number) => void;
-    /**
-     * Listen to section in channel changes
-     * @param channelId - channel id
-     * @param cb - callback on sections change or error
-     * @param limit - sections count
-     */
-    subscribeToSectionsInChannel: (channelId: string, cb: (error: null | Error, data: null | {
-        sections: Section[];
-        hasNextPage: boolean;
-    }, fetchMore: null | ((count?: number) => void), isLoading: boolean) => void, limit?: number) => void;
-    /**
-     * Listen to channels in widget changes
-     * @param widgetId - widget id
-     * @param cb - callback on channels change or error
-     * @param limit - channels count
-     */
-    subscribeToChannelsInWidget: (widgetId: string, cb: (error: null | Error, data: null | {
-        channels: Channel[];
-        hasNextPage: boolean;
-    }, fetchMore: null | ((count?: number) => void), isLoading: boolean) => void, limit?: number) => void;
-    subscribeToScreen: SubscribeToScreen;
-    subscribeToItemsInRow: SubscribeToItemsInRow;
-    subscribeToRowsInScreen: SubscribeToRowsInScreen;
-    subscribeToTaggedVideos: SubscribeToTaggedVideos;
-    registerOverlayCallbacks: (callbacks: {
-        onShow: () => void;
-        onHide: () => void;
-    }) => void;
-};
-declare type TivioGetters = {
-    isTivioLoaded: (cb: (isLoaded: boolean) => void) => boolean;
-    isSignedIn: () => boolean;
-    /**
-     * Get channel by its id.
-     * @param channelId - channel id
-     * @returns {Promise<Channel | null>} channel or null if channel does not exists
-     */
-    getChannelById: (channelId: string) => Promise<Channel | null>;
-    /**
-     * Get (or create) player wrapper instance
-     * @param opt - player getter options
-     * @returns {PlayerWrapper} player wrapper instance
-     */
-    getPlayerWrapper: (opt: {
-        playerWrapperId?: string;
-    }) => PlayerWrapper;
-    getOrganizationScreens: () => Promise<Screen[]>;
-    getOrganizationSubscriptions: () => Promise<Monetization[] | undefined>;
-    /**
-     * Get section by its id.
-     * @param sectionId - section id
-     * @returns {Promise<{section: Section, channel: Channel} | null>} section and channel or null if channel or section does not exists
-     */
-    getSectionById: (sectionId: string) => Promise<Section | null>;
-    /**
-     * Get video by its id.
-     * @param videoId - video id
-     * @returns {Promise<Video | null>} video or null if video does not exists
-     */
-    getVideoById: (videoId: string) => Promise<Video | null>;
-    /**
-     * Get widget by its id.
-     * @param widgetId - widget id
-     * @returns {Promise<Widget | null>} widget or null if widget does not exists
-     */
-    getWidgetById: (widgetId: string) => Promise<Widget | null>;
-    /**
-     * Get player capabilities based on user's browser and OS as resolved by Tivio.
-     * @returns PlayerCapability[]
-     */
-    getPlayerCapabilities: () => PlayerCapability[];
-};
-interface TivioAuth {
-    changePassword: (newPassword: string) => Promise<void>;
-    changeUserPhoto(file: File): Promise<void>;
-    removeUserPhoto(): Promise<void>;
-    getPurchasedVodsWithInitializedVideos: () => Promise<Purchase[]>;
-    /**
-     * @param email
-     * @param password
-     */
-    createUserWithEmailAndPassword: CreateUserWithEmailAndPassword;
-    /**
-     * Sign in the user and starts listening on his purchases
-     * @param email
-     * @param password
-     */
-    signInWithEmailAndPassword: (email: string, password: string) => Promise<void>;
-    initializeUser: () => Promise<void>;
-    signOut: () => Promise<void>;
-    /**
-     * Used for reset forgotten password by user
-     */
-    resetPassword: (email: string) => Promise<void>;
-    createFreePurchase: (monetizationId: string) => Promise<void>;
-}
-export interface RouterOverrides {
-    goToVideoDetailPage: (videoId: string) => void;
-    goToSeriesDetailPage: (tagId: string) => void;
-    goToTagPage: (tagId: string) => void;
-    goToLoginScreen: () => void;
-    goBack: () => void;
-    goLivePlayer: (videoId: string) => void;
-    goVodPlayer: (tvChannelId: string) => void;
-}
-export interface RouterOverridesContextState {
-    routerOverrides: RouterOverrides;
-}
-declare type TivioComponents = {
-    AdIndicationButtonWeb: React.ReactNode;
-    Markers: React.ReactNode;
-    PlayerDataContext: React.ReactNode;
-    Provider: React.ComponentType<RemoteProviderProps>;
-    Recommendation: React.ReactNode;
-    SkipButtonWeb: React.ReactNode;
-    /**
-     * @deprecated will be removed in in @tivio/sdk-react@4
-     */
-    VideoAdBanner: React.ReactNode;
-    WebPlayer: React.ComponentType<WebPlayerProps>;
-    Widget: React.ComponentType<TivioWidgetProps>;
-    TvPlayer: React.ComponentType<WebPlayerProps>;
-    PlayerDataContextProvider: React.ComponentType<{
-        id: string;
-    }>;
-    SkipButtonTv: React.ComponentType<{
-        Button: React.ComponentType;
-        Label: React.ComponentType;
-        Container: React.ComponentType;
-        onStarted?: () => any;
-        onEnded?: () => any;
-    }>;
-    TvApp: React.ComponentType<TvAppProps>;
-    CustomerScreen: React.ComponentType<{
-        screenId: string;
-    }>;
-    WebTagScreen: React.ComponentType<{
-        tagId: string;
-        onError?: (error: Error) => void;
-    }>;
-    WebSearchScreen: React.ComponentType<{
-        searchQuery?: string;
-    }>;
-    WebRow: React.ComponentType<WebRowProps>;
-    WebTile: React.ComponentType<{
-        item?: Video | Tag;
-    } & TilePropsPartial>;
-    FeatureSupportCheck: React.ComponentType<{}>;
-};
-declare type AdSegment = {
-    id: string;
-    /**
-     * @deprecated alias to secondsToEnd * 1000
-     */
-    remainingMs: number;
-    secondsToEnd: number;
-    secondsToSkippable: number | null;
-    canSeek: boolean;
-    /**
-     * true if is skippable and skip countdown has passed
-     */
-    canSkip: boolean;
-    /**
-     * true ad if is skippable after some skipDelayMs (if it is skippable, skipDelayMs is defined)
-     */
-    isSkippable: boolean;
-    skip: () => any;
-};
-declare type TivioHooks = {
-    useAd: () => [(AdSource | null)];
-    useAdSegment: () => AdSegment | null;
-    useCancelSubscription: UseCancelSubscription;
-    useItemsInRow: (rowId: string, options: PaginationOptions) => {
-        pagination: PaginationInterface<ItemsInRow> | null;
-        error: Error | null;
-    };
-    usePurchaseRecovery: () => {
-        purchaseRecoveryResult?: string;
-        loading: boolean;
-        error?: GenericOnCallError;
-        purchaseRecovery: (monetizationId: string) => void;
-    };
-    useRowsInScreen: (screenId: string, options: PaginationOptions) => {
-        pagination: PaginationInterface<Row> | null;
-        error: Error | null;
-    };
-    useTaggedVideos: (tagIds: string[], options: SubscribeToItemsInRowOptions) => {
-        pagination: PaginationInterface<Video> | null;
-        error: Error | null;
-    };
-    useSearch: UseSearch;
-    useVideo: (videoId: string) => {
-        data: Video | null;
-        error: string | null;
-    };
-    useVoucher: (voucherId: string) => any;
-    /**
-     * @deprecated will be removed in version
-     */
-    useLastVideoByWidgetId: (widgetId: string) => Video | null;
-    useWatchWithoutAdsOffer: () => {
-        canPurchaseWatchWithoutAds: boolean;
-        showPurchaseDialog: () => void;
-    };
-    useApplyInviteCode: () => {
-        applyInviteCodeResult?: boolean;
-        loading: boolean;
-        error?: GenericOnCallError;
-        applyInviteCode: (code: string) => void;
-        inviteCodeReset: () => void;
-    };
-};
-export declare type UserPayload = Record<string, any>;
-declare type TivioBundle = {
-    components: TivioComponents;
-    getters: TivioGetters;
-    auth: TivioAuth;
-    hooks: TivioHooks;
-    init: (config: Config) => void | Promise<void>;
-    purchaseVideoWithQerko: (videoId: string, monetizationId: string, voucher?: {
-        expirationDate: Date;
-    }) => Promise<QerkoPaymentInfo>;
-    purchaseSubscriptionWithQerko: (monetizationId: string, voucher?: {
-        expirationDate: Date;
-    }) => Promise<QerkoPaymentInfo>;
-    cancelSubscriptionWithQerko: (subscriptionId: string) => Promise<QerkoCancellationInfo>;
-    setLanguage: (language: LangCode) => void;
-    setUser: (userId: string | null, userPayload?: UserPayload) => Promise<void>;
-    showConsentPreferences: () => void;
-    sources: TivioSources;
-    subscriptions: TivioSubscriptions;
-    internal: {
-        components: TivioInternalComponents;
-        hooks: TivioInternalHooks;
-        providers: TivioInternalProviders;
-    };
-};
-declare type TivioInternalComponents = {
-    PrimaryButton: React.ComponentType;
-    WebLandingScreen: React.ComponentType<{
-        logo?: string;
-    }>;
-    WebVideoScreen: React.ComponentType<{
-        videoId: string;
-    }>;
-    WebSeriesDetailScreen: React.ComponentType<WebSeriesDetailScreenProps>;
-};
-declare type TivioInternalHooks = {
-    useAuthOverlay: () => AuthOverlayState;
-    useSubscriptionsOverlay: () => SubscriptionOverlayState;
-    useQerkoOverlay: () => QerkoOverlayState;
-    usePurchasesWithVideos: () => {
-        purchases: Purchase[];
-    };
-    useOrganizationSubscriptions: () => {
-        subscriptions: Monetization[];
-    };
-    useIsMonetizationPurchased: () => {
-        isOneOfSubscriptionPurchased: (subscriptionIds: string[]) => boolean;
-    };
-    useReferralInfo: any;
-    useTvChannel: UseTvChannel;
-    useChannelSource: UseChannelSource;
-    useUser: () => {
-        user: User | null;
-        error: string | null;
-        isInitialized: boolean;
-    };
-};
-declare type TivioInternalProviders = {
-    AppThemeProvider: React.ComponentType;
-    AuthOverlayContextProvider: React.ComponentType;
-    CustomerProvider: React.ComponentType<{
-        customer: CUSTOMER_BUILD;
-        platform: PLATFORM;
-        children: any;
-    }>;
-    ConfigProvider: React.ComponentType;
-    UserContextProvider: React.ComponentType;
-    SubscriptionOverlayContextProvider: React.ComponentType;
-    QerkoOverlayContextProvider: React.ComponentType;
-    PurchasesWithVideosContextProvider: React.ComponentType;
-    OrganizationSubscriptionsContextProvider: React.ComponentType;
-    RouterOverridesContextProvider: React.ComponentType<RouterOverridesContextState>;
-};
-declare type TivioBundleFile = {
-    Tivio: TivioBundle;
-};
-interface SubscriptionOverlayData {
-    subscriptions?: Monetization[];
-    onPurchase?: () => void;
-    onClose?: () => void;
-}
-declare type SubscriptionOverlayState = {
-    data: SubscriptionOverlayData | null;
-    closeSubscriptionOverlay: () => void;
-    openSubscriptionOverlay: (data: SubscriptionOverlayData) => void;
-};
-interface QerkoData {
-    monetization: Monetization;
-    video?: Video;
-    onPurchase?: () => void;
-    onClose?: () => void;
-}
-interface QerkoOverlayState {
-    data: QerkoData | null;
-    openQerkoOverlay: ((data: QerkoData) => void);
-    closeQerkoOverlay: () => void;
-}
-declare type RemoteBundleState = {
-    config: InternalConfig;
-    error: string | null;
-    settings: Settings;
-    state: 'loading' | 'error' | 'ready';
-} & Nullable<TivioBundle>;
-/**
- * TODO: Duplicate, because we can't import types from core-js.
- */
-declare type NewVoucher = {
-    expirationDate: Date | number;
-};
-export type { RemoteBundleState, Config, Settings, InternalConfig, TivioBundle, TivioBundleFile, TivioHooks, TivioComponents, TivioAuth, TivioGetters, TivioSubscriptions, TivioInternalComponents, TivioInternalHooks, TivioInternalProviders, Events, PubSub, PlayerCapability, Currency, SubscriptionOverlayData, SubscriptionOverlayState, QerkoData, QerkoOverlayState, NewVoucher, };

package/dist/types/common.d.ts

@@ -1,6 +0,0 @@
-declare type Nullable<T> = {
-    [P in keyof T]: T[P] | null;
-};
-declare type Empty = void | Promise<void> | undefined | Promise<undefined>;
-declare type Disposer = () => void;
-export { Disposer, Empty, Nullable, };

package/dist/types/customPlayer.types.d.ts

@@ -1,171 +0,0 @@
-import { Empty } from './common';
-export declare type ChannelSource = {
-    new (uri: string, originalOptions: Record<string, any>, channelName: string, programName: string, programDescription: string, from: Date, to: Date): ChannelSource;
-    description: string;
-    name: string;
-    uri: string;
-    from: Date;
-    channelName: string;
-    to: Date;
-    type: 'channel';
-    watchWithoutAdsRecommendation: {
-        showPurchaseDialog: () => void;
-    } | null;
-};
-export declare type AdSource = {
-    new (uri: string, name: string, description: string, skipDelayMs: number | null, adDurationMs: number, trackingContext?: any, // internal Tivio types
-    adMarker?: any, // internal Tivio types
-    packInfo?: any, // internal Tivio types
-    provider?: any): AdSource;
-    description: string;
-    name: string;
-    uri: string;
-    durationMs: number;
-    skipDelayMs: number | null;
-    type: 'ad';
-    /**
-     * true if is skippable and skip countdown has passed
-     */
-    canSkip: boolean;
-    /**
-     * true ad if is skippable after some skipDelayMs (if it is skippable, skipDelayMs is defined)
-     */
-    isSkippable: boolean;
-    /**
-     * Skip ad. Only works when canSkip is true
-     */
-    skip: () => void;
-    /**
-     * Order in ad break (ad break is a group of ads played right after each other)
-     */
-    order: number;
-    /**
-     * Total number of ads in ad break (ad break is a group of ads played right after each other)
-     */
-    totalCount: number;
-    secondsToEnd: number;
-    secondsToSkippable: number | null;
-};
-export declare type VodTivioSource = {
-    new (uri: string, videoId: string, name: string, description: string, adMonetizationId?: string): VodTivioSource;
-    type: 'vod_tivio';
-    description: string;
-    name: string;
-    uri: string;
-};
-export declare type VodExternalSource = {
-    new (uri: string, monetizationId: string, name: string, description: string, originalOptions: Record<string, any>): VodTivioSource;
-    type: 'vod_external';
-    description: string;
-    name: string;
-    uri: string;
-};
-export declare type InputSource = AdSource | ChannelSource | VodTivioSource | VodExternalSource;
-declare type PlayerState = 'playing' | 'paused' | 'idle';
-export interface PlayerInterface {
-    pause: () => void;
-    /**
-     * unpause
-     */
-    play: () => void;
-    /**
-     * @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;
-    /**
-     * Source to be passed to player.
-     *
-     * Depending on autoplay settings it should either start playing
-     * immediately or just be loaded by player and stay paused.
-     */
-    setSource: (source: InputSource | null) => void;
-    /**
-     * volume in [0,1]
-     */
-    setVolume?: (volume: number) => void;
-    mute?: () => void;
-    /**
-     * restore volume to previous value
-     */
-    unmute?: () => void;
-}
-export declare type PlayerWrapper = {
-    /**
-     * Report that playback of video has finished
-     */
-    onPlaybackEnded: () => void;
-    /**
-     * Report video progress in milliseconds
-     */
-    onTimeChanged: (ms: number) => void;
-    /**
-     * Report that video state changed
-     */
-    onStateChanged: (state: PlayerState) => void;
-    /**
-     * Send source to Tivio
-     */
-    onSourceChanged: (source: InputSource | null) => void;
-    /**
-     * Report that video failed to load (never started playing)
-     */
-    onLoadError: (error: Error) => void;
-    /**
-     * Report that video failed during playback (successfully loaded and then failed, e.g. part of stream is invalid)
-     */
-    onError: (error: Error) => void;
-    /**
-     * Unpause video
-     */
-    play: () => void;
-    /**
-     * Pause video
-     */
-    pause: () => void;
-    /**
-     * Currently playing source
-     */
-    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;
-        removeAllListeners: () => void;
-    };
-    /**
-     * Register a low level player that implements player methods, like play video, change volume, etc.
-     */
-    register: (playerInterface: PlayerInterface) => void;
-    /**
-     * duration of current source in ms (both setter and getter)
-     */
-    durationMs: number | null;
-    isPlaybackStarted: boolean;
-    isPaused: boolean;
-    isPlaying: boolean;
-    isIdle: boolean;
-    error: Error | null;
-    /**
-     * Replay the video that finished playback
-     */
-    replay: () => void;
-    /**
-     * Retry to play a video that failed to start playing (e.g. due to a network error)
-     */
-    retry: () => void;
-    togglePlayPause: () => void;
-    seekTo: (ms: number) => void;
-    /**
-     * set volume to value between 0,1
-     */
-    setVolume: (volume: number) => void;
-    /**
-     * change volume by value between -1,1
-     */
-    changeVolumeBy: (volume: number) => void;
-    setMuted: (muted: boolean) => void;
-    toggleMuted: () => void;
-};
-export declare type UsePlayerEvent = <T = any>(eventName: string) => T | null;
-export {};