@tivio/sdk-react 4.1.0 → 4.3.0

package/dist/sdk-react.d.ts

@@ -55,6 +55,12 @@ export declare type AdMetadata = {
     skip: () => void;
 } | null;
 
+/**
+ * @public
+ */
+export declare interface AdMonetization extends Monetization {
+}
+
 /**
  * @public
  */
@@ -156,35 +162,6 @@ export declare type Assets = {
     [assetName: string]: ScalableAsset;
 };
 
-/**
- * @public
- */
-export 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;
-};
-
-/**
- * @public
- */
-export declare type AuthOverlayState = {
-    type: AuthOverlayType;
-    closeAuthOverlay: () => void;
-    openAuthOverlay: (type: AuthOverlayType, payload?: AuthOverlayPayload) => void;
-    payload?: AuthOverlayPayload | null;
-};
-
-/**
- * @public
- */
-export declare type AuthOverlayType = 'login' | 'registration' | 'closed' | 'reset-password';
-
 /**
  * @public
  */
@@ -210,6 +187,11 @@ export declare type BadRequestError = Error & {
     };
 };
 
+export declare enum BannerItemComponent {
+    CLASSIC = "CLASSIC",
+    SPLITTED = "SPLITTED"
+}
+
 /**
  * @public
  */
@@ -224,7 +206,7 @@ export declare type BannerProps = {
     cover: string;
     overlay: boolean;
     price: string;
-    hasRoundCorners: boolean;
+    borderRadius?: string | number;
     buttonText?: string;
     onButtonClick?: () => void;
 };
@@ -380,6 +362,7 @@ export declare type CreateUserWithEmailAndPassword = (email: string, password: s
 export declare const CURRENCIES: string[];
 
 /**
+ * Three upper-case letters according to ISO-4217.
  * @public
  */
 export declare type Currency = 'CZK' | 'EUR' | 'USD';
@@ -414,11 +397,60 @@ export declare type Customizations = {
          */
         coverWidth: number;
         fontWeight: string | number;
+        overlayWidth: string | number;
+        text: {
+            width: string;
+            location: 'center' | 'bottom';
+            /**
+             * Font size in px
+             */
+            fontSize: number;
+        };
+    };
+    Row: {
+        /**
+         * Customizations of Banner component that is used as Row on Customer screen (e.g. WebBannerData)
+         */
+        Banner: {
+            borderRadius: string | number;
+        };
+        header: {
+            opacity: number;
+        };
     };
     Header: {
         backgroundColor: string;
         activeLinkUnderlineColor: string;
         logoHeight: string;
+        borderBottom: string;
+    };
+    VideoDetail: {
+        Banner: {
+            title: {
+                fontSize: string;
+                marginTop: number | string;
+                width: string;
+            };
+            overlays: {
+                left: {
+                    width: string;
+                    backgroundImage: string;
+                };
+                bottom: {
+                    backgroundImage: string;
+                };
+            };
+        };
+        TagsRow: {
+            /**
+             * Tags of this tag type is shown in tags row on video detail screen
+             */
+            tagTypeId: string;
+            /**
+             * Row title
+             */
+            title: string;
+        };
     };
     Input: InputOptions;
     landing: {
@@ -513,6 +545,22 @@ export declare type DocumentOptions = Partial<{
     subscribeOnChanges: boolean;
 }>;
 
+/**
+ * @public
+ */
+export declare interface Duration {
+    units: DurationUnits;
+    value: number;
+}
+
+/**
+ * @public
+ */
+export declare enum DurationUnits {
+    DAY = "day",
+    MONTH = "month"
+}
+
 /**
  * @public
  */
@@ -565,6 +613,21 @@ export declare interface GenericOnCallError {
  */
 export declare const getPubSub: () => PubSub;
 
+/**
+ * Response from Tivio getPurchaseInfo HTTP endpoint.
+ *
+ * @public
+ */
+export declare type GetPurchaseInfoResponse = {
+    monetizationId: string;
+    monetization: PurchaseMonetization;
+    status: PurchaseStatus;
+    video?: {
+        id: string;
+        name: string | Translation;
+    };
+};
+
 /**
  * @public
  */
@@ -709,6 +772,7 @@ export declare enum LangCode {
     FR = "fr",
     IT = "it",
     PL = "pl",
+    PT = "pt",
     SK = "sk",
     ES = "es"
 }
@@ -761,6 +825,20 @@ export declare type LiveTvChannelSource = SourceBase & {
     channelName: string;
 };
 
+/**
+ * @public
+ */
+export declare type LocationField = {
+    /**
+     * Two-letter uppercase continent code (TODO not sure if this ISO-3166 format or something else, we get these from maxmind service)
+     */
+    continentCode?: 'AF' | 'AN' | 'AS' | 'EU' | 'NA' | 'OC' | 'SA';
+    /**
+     * Two-letter uppercase country code according to ISO-3166 format (see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)
+     */
+    countryIsoCode?: string;
+};
+
 declare interface Logger {
     /** important messages */
     warn(...data: LoggerArgs): void;
@@ -816,14 +894,9 @@ export declare interface MigratedVideoExternals {
  */
 export declare interface Monetization {
     id: string;
-    price?: string | number;
     type?: MonetizationType;
-    frequency?: MONETIZATION_FREQUENCY;
-    isPurchased?: boolean;
     name?: string;
     description?: string;
-    benefits?: Translation[];
-    localizedBenefits?: string[];
 }
 
 /**
@@ -893,6 +966,13 @@ export declare interface OrderBy {
     directionStr?: OrderByDirection;
 }
 
+/**
+ * The same as WhereFilter, but in array, for easier usage.
+ * Format: [field, directionStr] or [field]
+ * @public
+ */
+export declare type OrderByArray = [string, OrderByDirection] | [string];
+
 declare type OrderByDirection = 'desc' | 'asc';
 
 /**
@@ -1183,6 +1263,14 @@ export declare enum PlayerWrapperEventType {
  */
 export declare type PlayerWrapperEventTypeType = `${PlayerWrapperEventType}`;
 
+/**
+ * @public
+ */
+export declare interface Promotion {
+    duration?: Duration;
+    price?: number;
+}
+
 /**
  * @public
  */
@@ -1191,6 +1279,30 @@ export declare interface PubSub {
     subscribe: <K extends keyof Events>(triggerName: K, onMessage: (data: Events[K]) => Empty) => Disposer;
 }
 
+/**
+ * @public
+ */
+export declare interface PurchasableMonetization extends Monetization {
+    /**
+     * Price before any discounts (e.g. promotions).
+     */
+    originalPrice: number;
+    /**
+     * Final price (after discounts).
+     */
+    price?: string | number;
+    promotion: Promotion | null;
+    frequency?: MONETIZATION_FREQUENCY;
+    isPurchased?: boolean;
+    benefits?: Translation[];
+    localizedBenefits?: string[];
+    /**
+     * Set to true for subscriptions which is not possible to buy - typically for historical subscriptions which users
+     * still have bought but can't be purchased anymore.
+     */
+    purchaseDisabled?: boolean;
+}
+
 /**
  * @public
  */
@@ -1222,6 +1334,132 @@ export declare type Purchase = {
     voucherId?: string;
 };
 
+/**
+ * @public
+ */
+export declare enum PurchaseDocumentGateway {
+    'qerko' = "qerko",
+    'oktagon' = "oktagon",
+    'voucher' = "voucher",
+    'comgate' = "comgate"
+}
+
+/**
+ * Payload which is sent to organization's webhook (if provided). It is send only when purchase status changes to PAID,
+ * it means that it is send also when user applies the voucher.
+ *
+ * @public
+ */
+export declare type PurchaseEndpointPayload = {
+    /**
+     * Information about the purchase which changes status to PAID.
+     */
+    purchase: {
+        /**
+         * Two-letter upper-case continent code.
+         */
+        continentCode?: LocationField['continentCode'];
+        /**
+         * Two-letter upper-case country code according to ISO-3166 format (see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
+         */
+        countryIsoCode?: LocationField['countryIsoCode'];
+        /**
+         * Gateway name or "voucher".
+         */
+        gateway: PurchaseDocumentGateway;
+        /**
+         * Tivio ID of the purchase.
+         */
+        id: string;
+        /**
+         * Timestamp of the last change of the purchase - in this case it is timestamp when it was paid.
+         */
+        updated: number;
+    };
+    /**
+     * Information about the monetization which has been bought by this purchase. Monetization definition may change in time so information provided here
+     * reflects monetization definition in time of the purchase.
+     */
+    monetization: {
+        /**
+         * Currency in which the purchase has been made. Three upper-case letters according to ISO-4217.
+         */
+        currency?: Currency;
+        /**
+         * Frequency in which the user will be charged.
+         * One of "ONE_TIME_PAYMENT", "DAILY", "WEEKLY", "MONTHLY" and "ANNUALLY.
+         */
+        frequency?: MONETIZATION_FREQUENCY | null;
+        /**
+         * Tivio ID of the monetization.
+         */
+        id: string;
+        /**
+         * Price of the purchase.
+         */
+        price?: number;
+        /**
+         * Name of the monetization.
+         */
+        title?: string;
+        /**
+         * Type of the monetization ("transaction" or "subscription").
+         */
+        type: MonetizationType;
+    };
+    /**
+     * Information about the video which has been bought by this purchase. Provided only for transaction purchases.
+     */
+    video?: {
+        /**
+         * Tivio ID of the video.
+         */
+        id: string;
+        /**
+         * Name of the video.
+         */
+        name: string | Translation;
+    };
+    /**
+     * Information about the user who made this purchase.
+     */
+    user: {
+        /**
+         * User's e-mail.
+         */
+        email: string;
+        /**
+         * External ID of the user.
+         */
+        externalUserId: string;
+        /**
+         * Tivio ID of the user.
+         */
+        id: string;
+        /**
+         * User's name.
+         */
+        name: string;
+    };
+    /**
+     * Information about the voucher. Provided only when purchase is purchase (not application) of the voucher.
+     */
+    voucher?: {
+        /**
+         * Voucher code.
+         */
+        code: string;
+        /**
+         * Voucher expiration timestamp.
+         */
+        expiration: number;
+        /**
+         * Duration (in seconds) after which purchase is considered expired. If undefined, monetization's duration is used.
+         */
+        purchaseDuration?: number;
+    };
+};
+
 /**
  * @public
  */
@@ -1275,7 +1513,7 @@ export declare interface QerkoCancellationInfo {
  * @public
  */
 export declare interface QerkoData {
-    monetization: Monetization;
+    monetization: PurchasableMonetization;
     item?: Video | TvChannel;
     onPurchase?: () => void;
     onClose?: () => void;
@@ -1373,13 +1611,14 @@ export declare type RequiredNullable<T> = {
  * @public
  */
 export declare interface RouterOverrides {
-    goToVideoDetailPage: (videoId: string) => void;
+    goToVideoDetailPage: (videoIdOrUrlName: string) => void;
     goToSeriesDetailPage: (tagId: string) => void;
     goToTagPage: (tagId: string) => void;
-    goToLoginScreen: () => void;
+    goToLoginPage: () => void;
+    goToRegistrationPage: () => void;
     goBack: () => void;
-    goLivePlayer: (videoId: string) => void;
-    goVodPlayer: (tvChannelId: string) => void;
+    goLivePlayer: (tvChannelId: string) => void;
+    goVodPlayer: (videoIdOrUrlName: string) => void;
     goToHome: () => void;
 }
 
@@ -1676,8 +1915,8 @@ export declare type SubscribeToTaggedVideosOptions = SubscribeToItemsInRowOption
  * @public
  */
 export declare interface SubscriptionCardProps {
-    subscription: Monetization;
-    onClick: (subscription: Monetization) => void;
+    subscription: PurchasableMonetization;
+    onClick: (subscription: PurchasableMonetization) => void;
     buttonLabel: string;
     purchased: boolean;
     focused?: boolean;
@@ -1694,7 +1933,7 @@ declare type SubscriptionInfo = {
  * @public
  */
 export declare interface SubscriptionOverlayData {
-    subscriptions?: Monetization[];
+    subscriptions?: PurchasableMonetization[];
     onPurchase?: () => void;
     onClose?: () => void;
 }
@@ -1733,9 +1972,15 @@ export declare type TaggedVideosOrderByField = 'seasonNumber' | 'episodeNumber'
  * @internal
  */
 export declare type TileOptions = {
-    focusedShadow: boolean;
     focusedShadowColor?: string;
     borderColor: string;
+    /**
+     * This property is ignored for CIRCLED tiles, they always have border-radius: 50%;
+     */
+    borderRadius: string | number;
+    innerContainer: {
+        margin: string;
+    };
     innerLabel: {
         /**
          * Font size in px
@@ -1745,10 +1990,20 @@ export declare type TileOptions = {
     bottomLabel: {
         opacity: string | number;
         fontWeight: string;
+        /**
+         * Font size in px
+         */
+        fontSize: number;
     };
     sizes: {
         [variant in TileSizeVariant]: TileSizesMap;
     };
+    badge: {
+        /**
+         * Font size in px
+         */
+        fontSize: number;
+    };
 };
 
 /**
@@ -1758,6 +2013,7 @@ export declare type TileProps = {
     cover: string;
     bottomLabel: string;
     bottomLabelAreaHeight: number;
+    bottomLabelTextLinesCount: number;
     innerLabel: string;
     duration: string;
     price: string | null;
@@ -1792,7 +2048,11 @@ export declare type TileSizes = {
     coverWidth: number;
     coverHeight: number;
     cellPaddingRight: number;
-    labelHeight: number;
+    /**
+     * Count of lines of label text.
+     * Now only bottom label supports multiline text.
+     */
+    labelLinesCount: number;
 };
 
 /**
@@ -1826,6 +2086,7 @@ export declare interface TivioAuth {
      * @param password
      */
     signInWithEmailAndPassword: (email: string, password: string) => Promise<string | null>;
+    signInWithCustomToken: (token: string) => Promise<string | null>;
     signOut: () => Promise<void>;
     /**
      * Used for reset forgotten password by user
@@ -2017,7 +2278,7 @@ export declare type TivioInternalComponents = {
         logo?: string;
     }>;
     WebVideoScreen: React_2.ComponentType<{
-        videoId: string;
+        videoIdOrUrlName: string;
     }>;
     WebSeriesDetailScreen: React_2.ComponentType<WebSeriesDetailScreenProps>;
 };
@@ -2026,20 +2287,33 @@ export declare type TivioInternalComponents = {
  * @public
  */
 export declare type TivioInternalHooks = {
-    useAuthOverlay: () => AuthOverlayState;
     useSubscriptionsOverlay: () => SubscriptionOverlayState;
     useQerkoOverlay: () => QerkoOverlayState;
     usePurchasesWithVideos: () => {
         purchases: Purchase[];
     };
-    useOrganizationSubscriptions: () => {
-        subscriptions: Monetization[];
+    useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean) => {
+        subscriptions: PurchasableMonetization[];
     };
     useIsMonetizationPurchased: () => {
         isOneOfSubscriptionPurchased: (subscriptionIds: string[]) => boolean;
     };
-    useReferralInfo: any;
+    useReferralInfo: (referralToken: string) => ({
+        data: {
+            email: string;
+            externalUserId: string;
+            promotionId?: string;
+            referralId: string;
+            promotion?: any;
+        };
+        error: Error | null;
+        loading: boolean;
+    });
     useTvChannel: UseTvChannel;
+    usePaymentOverlay: () => {
+        videoIdOrUrlName: string | null;
+        setVideoIdOrUrlName: (videoIdOrUrlName: string | null) => void;
+    };
     useChannelSource: UseChannelSource;
     useUser: () => {
         user: User | null;
@@ -2053,7 +2327,6 @@ export declare type TivioInternalHooks = {
  */
 export declare type TivioInternalProviders = {
     AppThemeProvider: React_2.ComponentType;
-    AuthOverlayContextProvider: React_2.ComponentType;
     CustomerProvider: React_2.ComponentType<{
         customer: CUSTOMER_BUILD;
         platform: PLATFORM;
@@ -2064,6 +2337,10 @@ export declare type TivioInternalProviders = {
     SubscriptionOverlayContextProvider: React_2.ComponentType;
     QerkoOverlayContextProvider: React_2.ComponentType;
     PurchasesWithVideosContextProvider: React_2.ComponentType;
+    PaymentOverlayContextProvider: React_2.ComponentType;
+    /**
+     * @deprecated not used in our app, can be removed when no sdk in production uses it
+     */
     OrganizationSubscriptionsContextProvider: React_2.ComponentType;
     RouterOverridesContextProvider: React_2.ComponentType<RouterOverridesContextState>;
 };
@@ -2451,8 +2728,8 @@ export declare const useMarkers: () => Marker[] | null;
 /**
  * @public
  */
-export declare const useOrganizationSubscriptions: () => {
-    subscriptions: Monetization[];
+export declare const useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean | undefined) => {
+    subscriptions: PurchasableMonetization[];
 };
 
 /**
@@ -2553,7 +2830,7 @@ export declare enum UserType {
  */
 export declare type UseSearch = <T extends ALGOLIA_INDEX_NAME>(indexName: T, options?: UseSearchOptions) => {
     search: (query: string) => void;
-    pagination: PaginationInterface<UseSearchResult<T>> | null;
+    pagination: Omit<PaginationInterface<UseSearchResult<T>>, 'loading'> | null;
     error: Error | null;
     isLoading: boolean;
     lastQuery: string;
@@ -2630,10 +2907,10 @@ export declare const useUser: () => {
 
 /**
  * Use video
- * @param videoId - video id
+ * @param videoIdOrUrlName - video id or video nice url (e.g. some-interesting-video)
  * @public
  */
-export declare const useVideo: (videoId?: string | undefined) => {
+export declare const useVideo: (videoIdOrUrlName?: string | undefined) => {
     data: Video | null;
     error: string | null;
 };
@@ -2719,14 +2996,15 @@ export declare interface Video extends RowItem {
     image: string | null;
     isPlayable: boolean;
     monetizations: Monetization[];
-    monetization: Monetization | undefined;
     transactionId?: string;
-    transaction: Monetization | undefined;
-    subscriptions: Monetization[];
+    sources?: any[];
+    transaction: PurchasableMonetization | undefined;
+    subscriptions: PurchasableMonetization[];
     subscriptionIds: string[];
     isPlaylist: boolean;
     name: string;
-    description?: string;
+    urlNames?: string[];
+    urlName?: string;
     price: number | null;
     detailedPrice: DetailedPrice | null;
     uri: string;
@@ -2801,6 +3079,13 @@ export declare enum VideoType {
     SERIES = "SERIES"
 }
 
+/**
+ * @public
+ */
+export declare type VideoUrlName = {
+    [key in LangCode]?: string[];
+};
+
 /**
  * @public
  */
@@ -2926,6 +3211,13 @@ export declare interface WhereFilter {
     value: any;
 }
 
+/**
+ * The same as WhereFilter, but in array, for easier usage.
+ * Format: [field, operator, value]
+ * @public
+ */
+export declare type WhereFilterArray = [string, WhereFilterOp, any];
+
 declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tivio/sdk-react",
-    "version": "4.1.0",
+    "version": "4.3.0",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "source": "src/index.ts",
@@ -30,7 +30,7 @@
         "@material-ui/core": "^4.11.2",
         "@material-ui/icons": "^4.11.2",
         "@sentry/browser": "^6.1.0",
-        "@tivio/common": "1.1.97",
+        "@tivio/common": "1.1.99",
         "dayjs": "^1.11.0",
         "es7-object-polyfill": "^1.0.1",
         "firebase": "8.10.1",