@tivio/sdk-react 4.1.0 → 4.3.0

package/README.md

@@ -6,6 +6,18 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* v4.3.0:
+  * minor: add GetPurchaseInfoResponse and PurchaseEndpointPayload to exported types
+  * minor: support for disabling purchase of specified subscriptions (new param in useOrganizationSubscriptions hook)
+  * minor: more specific PurchasableMonetization type usage instead of Monetization
+  * minor: monetization property deleted from Video type
+  * minor: monetization now has originalPrice and promotion properties available
+  * patch: remove not used OrganizationSubscriptionsContext, **this change requires bundle 3.20.0 or newer**
+
+* v4.2.0:
+  * minor: fix useSearch loading type
+  * patch: added italian language to `LangCode` enum
+
 * v4.1.0
   * patch: added italian language to `LangCode` enum
   * minor: fixed spanish language code in `LangCode` enum (`sp` -> `es`)

package/README.md.bak

@@ -6,6 +6,18 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* v4.3.0:
+  * minor: add GetPurchaseInfoResponse and PurchaseEndpointPayload to exported types
+  * minor: support for disabling purchase of specified subscriptions (new param in useOrganizationSubscriptions hook)
+  * minor: more specific PurchasableMonetization type usage instead of Monetization
+  * minor: monetization property deleted from Video type
+  * minor: monetization now has originalPrice and promotion properties available
+  * patch: remove not used OrganizationSubscriptionsContext, **this change requires bundle 3.20.0 or newer**
+
+* v4.2.0:
+  * minor: fix useSearch loading type
+  * patch: added italian language to `LangCode` enum
+
 * v4.1.0
   * patch: added italian language to `LangCode` enum
   * minor: fixed spanish language code in `LangCode` enum (`sp` -> `es`)

package/dist/index.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;
 };
@@ -355,6 +337,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';
@@ -425,6 +408,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
  */
@@ -477,6 +476,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
  */
@@ -614,6 +628,7 @@ export declare enum LangCode {
     FR = "fr",
     IT = "it",
     PL = "pl",
+    PT = "pt",
     SK = "sk",
     ES = "es"
 }
@@ -666,6 +681,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;
@@ -721,14 +750,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[];
 }
 
 /**
@@ -788,6 +812,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';
 
 /**
@@ -1078,6 +1109,14 @@ export declare enum PlayerWrapperEventType {
  */
 export declare type PlayerWrapperEventTypeType = `${PlayerWrapperEventType}`;
 
+/**
+ * @public
+ */
+export declare interface Promotion {
+    duration?: Duration;
+    price?: number;
+}
+
 /**
  * @public
  */
@@ -1086,6 +1125,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
  */
@@ -1117,6 +1180,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
  */
@@ -1170,7 +1359,7 @@ export declare interface QerkoCancellationInfo {
  * @public
  */
 export declare interface QerkoData {
-    monetization: Monetization;
+    monetization: PurchasableMonetization;
     item?: Video | TvChannel;
     onPurchase?: () => void;
     onClose?: () => void;
@@ -1259,13 +1448,14 @@ export declare type RemoteProviderProps = {
  * @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;
 }
 
@@ -1562,8 +1752,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;
@@ -1580,7 +1770,7 @@ declare type SubscriptionInfo = {
  * @public
  */
 export declare interface SubscriptionOverlayData {
-    subscriptions?: Monetization[];
+    subscriptions?: PurchasableMonetization[];
     onPurchase?: () => void;
     onClose?: () => void;
 }
@@ -1622,6 +1812,7 @@ export declare type TileProps = {
     cover: string;
     bottomLabel: string;
     bottomLabelAreaHeight: number;
+    bottomLabelTextLinesCount: number;
     innerLabel: string;
     duration: string;
     price: string | null;
@@ -1662,6 +1853,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
@@ -1853,7 +2045,7 @@ export declare type TivioInternalComponents = {
         logo?: string;
     }>;
     WebVideoScreen: React_2.ComponentType<{
-        videoId: string;
+        videoIdOrUrlName: string;
     }>;
     WebSeriesDetailScreen: React_2.ComponentType<WebSeriesDetailScreenProps>;
 };
@@ -1862,20 +2054,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;
@@ -1889,7 +2094,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;
@@ -1900,6 +2104,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>;
 };
@@ -2279,8 +2487,8 @@ export declare const useMarkers: () => Marker[] | null;
 /**
  * @public
  */
-export declare const useOrganizationSubscriptions: () => {
-    subscriptions: Monetization[];
+export declare const useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean | undefined) => {
+    subscriptions: PurchasableMonetization[];
 };
 
 /**
@@ -2381,7 +2589,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;
@@ -2458,10 +2666,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;
 };
@@ -2547,14 +2755,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;
@@ -2629,6 +2838,13 @@ export declare enum VideoType {
     SERIES = "SERIES"
 }
 
+/**
+ * @public
+ */
+export declare type VideoUrlName = {
+    [key in LangCode]?: string[];
+};
+
 /**
  * @public
  */
@@ -2754,6 +2970,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';
 
 /**