@tivio/sdk-react 3.5.0 → 3.6.0

package/dist/index.d.ts

@@ -1,44 +1,10 @@
-import { AuthOverlayState } from '@tivio/common';
-import { Channel as Channel_2 } from '@tivio/common/dist/types/externalTypes/channel';
-import { Channel as Channel_3 } from '@tivio/common';
 import { ComponentType } from 'react';
-import { CreateUserWithEmailAndPassword } from '@tivio/common';
-import { Currency } from '@tivio/common';
-import { CUSTOMER_BUILD } from '@tivio/common';
+import { default as firebase_2 } from 'firebase';
+import type { default as firebase_3 } from 'firebase/app';
 import { FunctionComponentElement } from 'react';
-import { ItemsInRow } from '@tivio/common';
-import { Monetization } from '@tivio/common';
-import { PaginationInterface } from '@tivio/common';
-import { PaginationOptions } from '@tivio/common';
-import { PLATFORM } from '@tivio/common';
-import type { Purchase as Purchase_2 } from '@tivio/common';
-import { Purchase as Purchase_3 } from '@tivio/common/dist/types/externalTypes/user';
-import { QerkoCancellationInfo } from '@tivio/common';
-import type { QerkoPaymentInfo } from '@tivio/common';
-import { QerkoTransaction } from '@tivio/common';
+import { OrderByDirection } from '@firebase/firestore-types';
 import { default as React_2 } from 'react';
-import { Row } from '@tivio/common';
-import { Screen as Screen_2 } from '@tivio/common';
-import { ScreenOptions } from '@tivio/common';
-import { Section as Section_2 } from '@tivio/common/dist/types/externalTypes/section';
-import { Section as Section_3 } from '@tivio/common';
-import type { SubscribeToItemsInRow } from '@tivio/common';
-import { SubscribeToItemsInRowOptions } from '@tivio/common';
-import type { SubscribeToRowsInScreen } from '@tivio/common';
-import type { SubscribeToScreen } from '@tivio/common';
-import { SubscribeToTaggedVideos } from '@tivio/common';
-import { Tag } from '@tivio/common';
-import { TilePropsPartial } from '@tivio/common';
-import type { TvAppProps } from '@tivio/common';
-import { UseCancelSubscription } from '@tivio/common';
-import { UseChannelSource } from '@tivio/common';
-import type { User } from '@tivio/common';
-import { User as User_2 } from '@tivio/common/dist/types/externalTypes/user';
-import { UseSearch } from '@tivio/common';
-import type { UseTvChannel } from '@tivio/common';
-import { Video } from '@tivio/common';
-import { WebRowProps } from '@tivio/common';
-import { WebSeriesDetailScreenProps } from '@tivio/common';
+import { WhereFilterOp } from '@firebase/firestore-types';
 
 declare type AdSegment = {
     id: string;
@@ -101,11 +67,43 @@ export declare type AdSource = {
  * @public
  */
 export declare enum ALGOLIA_INDEX_NAME {
-    VIDEOS = 'videos',
-    VIDEOSDESC = 'videos_created_desc',
-    TAGS = 'tags',
-    TV_CHANNELS = 'tvChannels',
-    USERS = 'users'
+    VIDEOS = "videos",
+    VIDEOSDESC = "videos_created_desc",
+    TAGS = "tags",
+    TV_CHANNELS = "tvChannels",
+    USERS = "users"
+}
+
+declare interface Asset {
+    background: string;
+}
+
+declare type Assets = {
+    [assetName: string]: ScalableAsset;
+};
+
+declare type AuthOverlayPayload = {
+    prefilledData?: {
+        email: string;
+    };
+    /**
+     * "Goto" function (see router.utils.ts) to run after the overlay is closed. Null if no redirect is required.
+     * Defaults to homepage.
+     */
+    redirectAfterSubmit?: ((...args: any[]) => void) | null;
+};
+
+declare type AuthOverlayState = {
+    type: AuthOverlayType;
+    closeAuthOverlay: () => void;
+    openAuthOverlay: (type: AuthOverlayType, payload?: AuthOverlayPayload) => void;
+    payload?: AuthOverlayPayload | null;
+};
+
+declare type AuthOverlayType = 'login' | 'registration' | 'closed' | 'reset-password';
+
+declare interface AvailableSeason {
+    seasonNumber: number;
 }
 
 export declare type BadRequestError = Error & {
@@ -140,7 +138,10 @@ export declare type Channel = {
     recentVideos: Video[];
 };
 
-export declare const ChannelsContext: React_2.Context<DataState<Channel_3>>;
+declare interface Channel_2 {
+}
+
+export declare const ChannelsContext: React_2.Context<DataState<Channel_2>>;
 
 export declare type ChannelSource = {
     new (uri: string, originalOptions: Record<string, any>, channelName: string, programName: string, programDescription: string, from: Date, to: Date): ChannelSource;
@@ -156,6 +157,18 @@ export declare type ChannelSource = {
     } | null;
 };
 
+declare interface ChannelSource_2 {
+    type: 'ChannelSource';
+    uri: string;
+    originalOptions: any;
+    channelName: string;
+    programName: string;
+    programDescription: string;
+    from: Date;
+    to: Date;
+    poster?: string;
+}
+
 export declare interface ChannelSourcePojo {
     type: 'ChannelSource';
     uri: string;
@@ -179,6 +192,13 @@ export declare type Config = Pick<InternalConfig, 'bundleUrlOverride' | 'currenc
     runFeatureSupportCheck?: boolean;
 };
 
+declare type CoverPadding = {
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+};
+
 export declare const createPubSub: () => PubSub;
 
 /**
@@ -188,7 +208,18 @@ export declare const createRemotePackageLoader: () => (secret: string, conf: Int
 
 export declare const createUseRemoteBundle: () => (conf: InternalConfig) => RemoteBundleState;
 
-export { Currency }
+declare type CreateUserWithEmailAndPassword = (email: string, password: string, username?: string, referralToken?: string) => Promise<string | null>;
+
+export declare type Currency = 'CZK' | 'EUR' | 'USD';
+
+export declare enum CUSTOMER_BUILD {
+    OKTAGON = "OKTAGON",
+    JOJ = "JOJ",
+    MALL = "MALL",
+    GARAZ = "GARAZ",
+    U_KULATEHO_STOLU = "U_KULATEHO_STOLU",
+    INVESTOREES = "INVESTOREES"
+}
 
 declare interface DataState<T> {
     data: {
@@ -197,8 +228,23 @@ declare interface DataState<T> {
     setData: (key: string, data: HookData<T>) => void;
 }
 
+declare type DefaultOrderByField = 'created';
+
+declare type DetailedPrice = {
+    amount: number;
+    currency: Currency;
+    frequency?: MONETIZATION_FREQUENCY;
+};
+
 export declare type Disposer = () => void;
 
+declare type Disposer_2 = () => void;
+
+declare type DocumentOptions = Partial<{
+    lazyLoading: boolean;
+    subscribeOnChanges: boolean;
+}>;
+
 export declare type Empty = void | Promise<void> | undefined | Promise<undefined>;
 
 export declare type Events = {
@@ -206,6 +252,10 @@ export declare type Events = {
     'on-error': Error;
 };
 
+export declare type ExternalTvConfig = {
+    logo: string;
+};
+
 /**
  * @throws if fetch fails
  */
@@ -287,6 +337,11 @@ declare interface IntroMarker {
     skip: () => void;
 }
 
+declare type ItemsInRow = Tag | Video | TvChannel;
+
+/**
+ * Enum of all supported languages codes as in ISO 639-1
+ */
 export declare enum LangCode {
     CS = "cs",
     DE = "de",
@@ -297,6 +352,11 @@ export declare enum LangCode {
     SP = "sp"
 }
 
+declare type LinkedVideo = {
+    video: Video;
+    type: 'CUT' | 'TRAILER' | 'BONUS' | 'CHILD';
+};
+
 declare interface Logger {
     /** important messages */
     warn(...data: LoggerArgs): void;
@@ -326,7 +386,26 @@ export declare type Marker = {
     toMs?: number;
 };
 
-export { Monetization }
+export declare interface Monetization {
+    id: string;
+    price?: string | number;
+    type?: MonetizationType;
+    frequency?: MONETIZATION_FREQUENCY;
+    name?: string;
+    description?: string;
+    benefits?: Translation[];
+    localizedBenefits?: string[];
+}
+
+declare enum MONETIZATION_FREQUENCY {
+    ONE_TIME_PAYMENT = "ONE_TIME_PAYMENT",
+    DAILY = "DAILY",
+    WEEKLY = "WEEKLY",
+    MONTHLY = "MONTHLY",
+    ANNUALLY = "ANNUALLY"
+}
+
+declare type MonetizationType = 'advertisement' | 'transaction' | 'subscription';
 
 /**
  * TODO: Duplicate, because we can't import types from core-js.
@@ -339,12 +418,35 @@ export declare type Nullable<T> = {
     [P in keyof T]: T[P] | null;
 };
 
+declare interface OrderBy {
+    field: string;
+    directionStr?: OrderByDirection;
+}
+
 declare type PaginationData<T> = {
     items: T[];
     hasNextPage: boolean;
     fetchMore: Function;
 };
 
+declare type PaginationInterface<Entity> = {
+    items: Entity[];
+    fetchMore: () => void;
+    hasNextPage?: boolean;
+    loading?: boolean;
+};
+
+declare type PaginationOptions = Partial<{
+    limit: number;
+    noLimit: boolean;
+}>;
+
+export declare enum PLATFORM {
+    MOBILE = "MOBILE",
+    WEB = "WEB",
+    TV = "TV"
+}
+
 export declare interface PlayerCapability {
     codec: 'h264' | 'h265';
     encryption: 'fairplay' | 'none' | 'playready' | 'widevine';
@@ -480,6 +582,48 @@ export declare type Purchase = {
     video: Video | null;
 };
 
+declare type Purchase_2 = {
+    id: string;
+    isPurchased: boolean;
+    monetizationRef: firebase_3.firestore.DocumentReference | null;
+    monetization: PurchaseMonetization | null;
+    monetizationId: string | null;
+    type: MonetizationType | null;
+    videoId: string | null;
+    status: PurchaseStatus | null;
+    video: Video | null;
+    videoRef: firebase_3.firestore.DocumentReference | null;
+    expirationDate: Date | null;
+    isExpired: boolean;
+    voucherId?: string;
+};
+
+declare type PurchaseMonetization = {
+    currency: Currency;
+    period: number;
+    price: number;
+    type: MonetizationType;
+    title: string;
+    frequency: MONETIZATION_FREQUENCY | null;
+    /**
+     * If set, purchase (subscription) activated by voucher will stay valid for this amount of seconds.
+     * Otherwise, purchase will be valid for one "monetization frequency" period.
+     */
+    voucherPurchaseDuration?: number;
+};
+
+declare enum PurchaseStatus {
+    NEW = "NEW",
+    PAID = "PAID",
+    CANCELLED = "CANCELLED",
+    ERROR = "ERROR"
+}
+
+export declare interface QerkoCancellationInfo {
+    purchaseId: string;
+    status: PurchaseStatus;
+}
+
 export declare interface QerkoData {
     monetization: Monetization;
     video?: Video;
@@ -493,6 +637,26 @@ export declare interface QerkoOverlayState {
     closeQerkoOverlay: () => void;
 }
 
+export declare interface QerkoPaymentInfo {
+    webPaymentGatewayLink: string;
+    gatewayUri: string;
+    paymentQRCodeUri: string;
+    purchaseId: string;
+    currency: string;
+    amount: number;
+    monetizationType: MonetizationType;
+    recovery?: boolean;
+    monetizationFrequency: MONETIZATION_FREQUENCY;
+}
+
+declare interface QerkoTransaction {
+    paymentInfo: QerkoPaymentInfo | null;
+    paymentError: string | null;
+    paymentStatus: string | null;
+    getPaymentInfo: () => Promise<void>;
+    voucherId?: string;
+}
+
 export declare type RemoteBundleState = {
     config: InternalConfig;
     error: string | null;
@@ -519,6 +683,69 @@ export declare interface RouterOverridesContextState {
     routerOverrides: RouterOverrides;
 }
 
+declare interface Row {
+    id: string;
+    rowId: string;
+    name: string;
+    description?: string;
+    itemComponent: RowItemComponent;
+    rowComponent: RowComponent;
+    assets: Assets;
+    type: ScreenRowType;
+}
+
+export declare enum ROW_ITEM_TYPES {
+    VIDEO = "VIDEO",
+    TAG = "TAG",
+    TV_CHANNEL = "TV_CHANNEL"
+}
+
+declare enum RowComponent {
+    ROW = "ROW",
+    BANNER = "BANNER"
+}
+
+declare interface RowItem extends RowItemAssets {
+    itemType: ROW_ITEM_TYPES;
+    name?: string;
+    description?: string;
+    assets: Assets | null;
+}
+
+declare interface RowItemAssets {
+    landscape?: string | null;
+    portrait?: string | null;
+    circled?: string | null;
+    banner?: string | null;
+}
+
+declare enum RowItemComponent {
+    ROW_ITEM_PORTRAIT = "ROW_ITEM_PORTRAIT",
+    ROW_ITEM_LANDSCAPE = "ROW_ITEM_LANDSCAPE",
+    ROW_ITEM_CIRCLED = "ROW_ITEM_CIRCLED"
+}
+
+declare type ScalableAsset = {
+    '@1': Asset;
+    '@2'?: Asset;
+    '@3'?: Asset;
+};
+
+declare interface Screen_2 {
+    id: string;
+    name: string;
+    description?: string;
+    assets: Assets;
+    rows: Row[];
+}
+
+declare type ScreenOptions = Partial<{
+    language: LangCode;
+    initRows: boolean;
+}> & DocumentOptions;
+
+declare type ScreenRowType = 'filter' | 'custom' | 'continueToWatch' | 'favourites';
+
 export declare type Section = {
     id: string;
     name: string;
@@ -526,7 +753,10 @@ export declare type Section = {
     videos: Video[];
 };
 
-export declare const SectionsContext: React_2.Context<DataState<Section_3>>;
+declare interface Section_2 {
+}
+
+export declare const SectionsContext: React_2.Context<DataState<Section_2>>;
 
 export declare type Settings = {
     /**
@@ -545,6 +775,25 @@ export declare const setUser: (userId: string | null, payload?: UserPayload | un
 
 export declare const showGdprConsentPreferences: () => Promise<void>;
 
+declare type SubscribeToItemsInRow = (rowId: string, cb: (error: Error | null, data: PaginationInterface<ItemsInRow> | null) => void, options?: SubscribeToItemsInRowOptions) => Disposer_2;
+
+declare type SubscribeToItemsInRowOptions = Partial<{
+    fetchTags: boolean;
+}> & PaginationOptions;
+
+declare type SubscribeToRowsInScreen = (screenId: string, cb: (error: Error | null, data: PaginationInterface<Row> | null) => void, options?: PaginationOptions) => Disposer_2;
+
+declare type SubscribeToScreen = (screenId: string, cb: (error: Error | null, data: Screen_2 | null) => void, options?: ScreenOptions) => Disposer_2;
+
+declare type SubscribeToTaggedVideos = (tagIds: string[], cb: (error: Error | null, data: PaginationInterface<Video> | null) => void, options?: SubscribeToTaggedVideosOptions) => Disposer_2;
+
+declare type SubscribeToTaggedVideosOptions = SubscribeToItemsInRowOptions & {
+    orderBy?: (Omit<OrderBy, 'field'> & {
+        field: TaggedVideosOrderByField;
+    })[];
+    where?: WhereFilter[];
+};
+
 declare type SubscriptionInfo = {
     type: 'subscription';
     name: string;
@@ -564,6 +813,49 @@ export declare type SubscriptionOverlayState = {
     openSubscriptionOverlay: (data: SubscriptionOverlayData) => void;
 };
 
+declare interface Tag extends RowItem {
+    id: string;
+    tagId: string;
+    type?: string | null;
+    metadata?: any[];
+    color?: string;
+    detailBanner?: string;
+    availableSeasons?: AvailableSeason[];
+    isFavorite: boolean;
+    addToFavorites: () => void;
+    removeFromFavorites: () => void;
+}
+
+declare type TaggedVideosOrderByField = 'seasonNumber' | 'episodeNumber' | 'contentType' | DefaultOrderByField;
+
+declare type TileProps = {
+    cover: string;
+    isLoading: boolean;
+    bottomLabel: string;
+    bottomLabelAreaHeight: number;
+    innerLabel: string;
+    duration: string;
+    price: string | null;
+    focused: boolean;
+    onClick?: () => void;
+    hoverable: boolean;
+    overlay: boolean;
+    coverPadding: CoverPadding;
+    variant: RowItemComponent;
+    coverWidth: number;
+    progress?: number;
+    time?: string;
+    logo?: string;
+    coverHeight: number;
+    /**
+     * Margin of inner TileContainer.
+     * Now used for backward compatibility for WebTileGrid. Consider to use it other way.
+     */
+    containerMargin?: number | string;
+};
+
+declare type TilePropsPartial = Partial<TileProps>;
+
 export declare interface TivioAuth {
     changePassword: (newPassword: string) => Promise<void>;
     changeUserPhoto(file: File): Promise<void>;
@@ -927,6 +1219,31 @@ declare type TransactionInfo = {
     description: string;
 };
 
+/**
+ * Represents one string in every supported language mutation.
+ */
+export declare type Translation = {
+    [key in LangCode]: string;
+};
+
+declare type TvAppProps = {
+    customer: CUSTOMER_BUILD;
+};
+
+declare interface TvChannel extends RowItem {
+    name: string;
+    id: string;
+    path: string;
+    itemType: ROW_ITEM_TYPES;
+    country?: string;
+    filters: string[];
+    logo?: string;
+    hls: string;
+    dash: string;
+    purchasableMonetization: any | null;
+    price: number;
+}
+
 export declare const TvTivioProvider: React_2.FC<TivioProviderProps>;
 
 export declare const useAd: () => AdSource | null;
@@ -962,6 +1279,12 @@ export declare function useApplyInviteCode(): {
 
 export declare const useBetOffer: () => BetOffer | null;
 
+declare type UseCancelSubscription = (subscriptionId: string) => {
+    cancelSubscription: () => Promise<void>;
+    cancellationInfo: QerkoCancellationInfo | null;
+    error?: string | null;
+};
+
 export declare const useCancelSubscription: UseCancelSubscription;
 
 /**
@@ -984,6 +1307,11 @@ export declare const useChannelsInWidget: (widgetId: string, limit?: number) =>
     isLoading: boolean;
 };
 
+declare type UseChannelSource = (tvChannelId: string) => {
+    source: ChannelSource_2 | null;
+    error: Error | null;
+};
+
 export declare const useCurrentMarker: () => Marker | null;
 
 export declare const useFreePurchase: () => {
@@ -1046,10 +1374,24 @@ export declare const usePurchaseSubscription: (monetizationId: string, voucher?:
  * Return purchases with initialized video (purchases[i].video not null)
  */
 export declare const usePurchasesWithVideos: () => {
-    purchases: Purchase_3[];
+    purchases: Purchase_2[];
 };
 
-export { User }
+export declare type User = {
+    purchases: Purchase_2[];
+    allPurchases: Purchase_2[];
+    purchasedVods: Purchase_2[];
+    purchasedSubscriptions: Purchase_2[];
+    isPurchasesInitialized: boolean;
+    isSignedIn: boolean;
+    email?: string;
+    type?: UserType;
+    photoURL: string | null;
+    name?: string;
+    authUserId?: string;
+    favorites: any[];
+    watchedPositions: any[];
+};
 
 export declare const useRowsInScreen: (screenId: string, options?: PaginationOptions) => {
     pagination: PaginationInterface<Row> | null;
@@ -1058,6 +1400,11 @@ export declare const useRowsInScreen: (screenId: string, options?: PaginationOpt
 
 export declare type UserPayload = Record<string, any>;
 
+declare enum UserType {
+    ORGANIZATION_USER = "ORGANIZATION_USER",
+    TIVIO_USER = "TIVIO_USER"
+}
+
 /**
  * @deprecated
  *
@@ -1071,6 +1418,14 @@ export declare const useScreens: () => {
     screens: Screen_2[];
 };
 
+declare type UseSearch = <T extends ALGOLIA_INDEX_NAME>(indexName: T, options?: UseSearchOptions) => {
+    search: (query: string) => void;
+    pagination: PaginationInterface<UseSearchResult<T>> | null;
+    error: Error | null;
+    isLoading: boolean;
+    lastQuery: string;
+};
+
 /**
  * Full text search that returns entities based on search query.
  * @param indexName - index that search would be performed on ('videos', 'tags', etc.)
@@ -1078,6 +1433,12 @@ export declare const useScreens: () => {
  */
 export declare const useSearch: UseSearch;
 
+declare type UseSearchOptions = PaginationOptions & Partial<{
+    minQueryLength: number;
+}>;
+
+declare type UseSearchResult<T extends ALGOLIA_INDEX_NAME> = T extends ALGOLIA_INDEX_NAME.VIDEOS ? Video : T extends ALGOLIA_INDEX_NAME.TAGS ? Tag : T extends ALGOLIA_INDEX_NAME.TV_CHANNELS ? TvChannel : unknown;
+
 /**
  * Use section
  * @param sectionId - section id
@@ -1116,8 +1477,14 @@ export declare const useTivioReadyData: () => RemoteBundleState | null;
 
 export declare const useTransactionPayment: (videoId: string, monetizationId: string, voucher?: NewVoucher | undefined) => QerkoTransaction;
 
+declare type UseTvChannel = (tvChannelId: string) => {
+    tvChannel: TvChannel | null;
+    error: Error | null;
+    loading: boolean;
+};
+
 export declare const useUser: () => {
-    user: User_2 | null;
+    user: User | null;
     error: string | null;
     isInitialized: boolean;
 };
@@ -1170,7 +1537,72 @@ export declare const useWidget: (widgetId: string) => {
     widget: Widget | null;
 };
 
-export { Video }
+export declare interface Video extends RowItem {
+    id: string;
+    /**
+     * @deprecated use assets instead
+     */
+    cover: string | null;
+    created: Date;
+    sectionId: string | null;
+    channelId: string | null;
+    /**
+     * seconds
+     */
+    duration: number;
+    path: string;
+    tags: Tag[];
+    image: string | null;
+    isPlayable: boolean;
+    monetizations: Monetization[];
+    monetization: Monetization | undefined;
+    transactionId?: string;
+    transaction: Monetization | undefined;
+    subscriptions: Monetization[];
+    subscriptionIds: string[];
+    isPlaylist: boolean;
+    name: string;
+    description?: string;
+    price: number | null;
+    detailedPrice: DetailedPrice | null;
+    uri: string;
+    url: string;
+    adMonetizationId?: string;
+    from?: Date;
+    to?: Date;
+    detailBanner?: string;
+    linkedVideosRaw: any[];
+    linkedVideos: LinkedVideo[];
+    purchasableMonetization: any | null;
+    contentType: VideoContentType | null;
+    year?: number;
+    episodeNumber?: number;
+    seasonNumber?: number;
+    getTagsOfType: (type: string) => Tag[];
+    loadLinkedVideos: () => any;
+    getLinkedVideos: (type: any) => any;
+    trailer: Video | null;
+    watchPosition: number | null;
+    isFavorite: boolean;
+    addToFavorites: () => void;
+    removeFromFavorites: () => void;
+    availability: VideoAvailabilityField | null;
+}
+
+declare type VideoAvailabilityField = {
+    from: firebase_2.firestore.Timestamp;
+    to: firebase_2.firestore.Timestamp | null;
+    manual: boolean;
+};
+
+declare enum VideoContentType {
+    /**
+     * Default video content type
+     */
+    VIDEO = "VIDEO",
+    FILM = "FILM",
+    SERIES = "SERIES"
+}
 
 declare type VideoPath = string;
 
@@ -1264,6 +1696,24 @@ export declare interface WebPlayerProps {
     onPlayerControllerCreated?: (playerController: any) => void;
 }
 
+declare type WebRowProps = {
+    items?: ItemsInRow[];
+    variant?: RowItemComponent;
+    rowName?: string;
+    fetchMore?: () => void;
+    onTileClick?: (item: ItemsInRow) => void;
+};
+
+declare type WebSeriesDetailScreenProps = {
+    tagId: string;
+};
+
+declare interface WhereFilter {
+    field: string;
+    operator: WhereFilterOp;
+    value: any;
+}
+
 export declare type Widget = {
     id: string;
     channels: Channel[];