@tivio/sdk-react 4.3.0 → 4.4.1

package/README.md

@@ -6,6 +6,16 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* v4.4.1
+  * patch: added waitForTags param in useSearch hook for videos
+
+* v4.4.0
+  * minor: PrimaryButton component props type set to any for now
+  * patch: isPurchasableAsVoucher added to PurchasableMonetization
+  * patch: voucherPurchase flag added to purchase overlays
+  * patch: item added to MonetizationsSelectOverlayData
+  * minor: added hungarian language to `LangCode` enum
+
 * v4.3.0:
   * minor: add GetPurchaseInfoResponse and PurchaseEndpointPayload to exported types
   * minor: support for disabling purchase of specified subscriptions (new param in useOrganizationSubscriptions hook)

package/README.md.bak

@@ -6,6 +6,16 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* v4.4.1
+  * patch: added waitForTags param in useSearch hook for videos
+
+* v4.4.0
+  * minor: PrimaryButton component props type set to any for now
+  * patch: isPurchasableAsVoucher added to PurchasableMonetization
+  * patch: voucherPurchase flag added to purchase overlays
+  * patch: item added to MonetizationsSelectOverlayData
+  * minor: added hungarian language to `LangCode` enum
+
 * v4.3.0:
   * minor: add GetPurchaseInfoResponse and PurchaseEndpointPayload to exported types
   * minor: support for disabling purchase of specified subscriptions (new param in useOrganizationSubscriptions hook)

package/dist/index.d.ts

@@ -189,7 +189,7 @@ export declare type BadRequestError = Error & {
 
 export declare enum BannerItemComponent {
     CLASSIC = "CLASSIC",
-    SPLITTED = "SPLITTED"
+    SPLIT = "SPLIT"
 }
 
 /**
@@ -476,6 +476,13 @@ export declare interface GenericOnCallError {
  */
 export declare const getPubSub: () => PubSub;
 
+/**
+ * @public
+ */
+export declare type GetPurchasableMonetizationsOptions = {
+    includeMonetizationsWithPurchaseDisabled: boolean;
+};
+
 /**
  * Response from Tivio getPurchaseInfo HTTP endpoint.
  *
@@ -594,6 +601,11 @@ declare interface IntroMarker {
     skip: () => void;
 }
 
+/**
+ * @public
+ */
+export declare type ItemComponent = RowItemComponent | BannerItemComponent;
+
 /**
  * @public
  */
@@ -630,7 +642,8 @@ export declare enum LangCode {
     PL = "pl",
     PT = "pt",
     SK = "sk",
-    ES = "es"
+    ES = "es",
+    HU = "hu"
 }
 
 /**
@@ -763,9 +776,49 @@ export declare enum MONETIZATION_FREQUENCY {
     DAILY = "DAILY",
     WEEKLY = "WEEKLY",
     MONTHLY = "MONTHLY",
+    HALF_ANNUALLY = "HALF_ANNUALLY",
     ANNUALLY = "ANNUALLY"
 }
 
+/**
+ * @public
+ */
+export declare interface MonetizationCardProps {
+    subscription: PurchasableMonetization;
+    onClick: (subscription: PurchasableMonetization) => void;
+    buttonLabel: string;
+    purchased: boolean;
+    focused?: boolean;
+}
+
+/**
+ * @public
+ */
+export declare interface MonetizationsSelectOverlayData {
+    subscriptions?: PurchasableMonetization[];
+    /**
+     * Item from which monetization select was opened.
+     * Note: does not necessarily mean that result purchase will be transaction.
+     */
+    item?: Video | TvChannel;
+    /**
+     * If set to true, user is buying voucher.
+     * Otherwise, user is making a purchase for himself.
+     */
+    voucherPurchase?: boolean;
+    onPurchase?: () => void;
+    onClose?: () => void;
+}
+
+/**
+ * @public
+ */
+export declare type MonetizationsSelectOverlayState = {
+    data: MonetizationsSelectOverlayData | null;
+    closeMonetizationsSelectOverlay: () => void;
+    openMonetizationsSelectOverlay: (data: MonetizationsSelectOverlayData) => void;
+};
+
 /**
  * @public
  * @TODO change to enum
@@ -1139,7 +1192,15 @@ export declare interface PurchasableMonetization extends Monetization {
     price?: string | number;
     promotion: Promotion | null;
     frequency?: MONETIZATION_FREQUENCY;
-    isPurchased?: boolean;
+    /**
+     * Returns TRUE if subscription is purchased (and not expired) by user.
+     * Returns TRUE if transaction is purchased (and not expired) for transactionItemId.
+     * Returns FALSE otherwise.
+     *
+     * @param transactionItemId id of item for which transaction purchase is checked
+     * @param transactionField type of item (video or tvChannel)
+     */
+    isPurchased(transactionItemId?: string, transactionField?: 'videoId' | 'tvChannelId'): boolean;
     benefits?: Translation[];
     localizedBenefits?: string[];
     /**
@@ -1147,6 +1208,11 @@ export declare interface PurchasableMonetization extends Monetization {
      * still have bought but can't be purchased anymore.
      */
     purchaseDisabled?: boolean;
+    /**
+     * When set to true, users can buy this monetization as a voucher (e.g. to send it as a gift to a friend).
+     * If not set or set to false, users cannot buy it as a voucher.
+     */
+    isPurchasableAsVoucher?: boolean;
 }
 
 /**
@@ -1221,6 +1287,10 @@ export declare type PurchaseEndpointPayload = {
          * Timestamp of the last change of the purchase - in this case it is timestamp when it was paid.
          */
         updated: number;
+        /**
+         * True if delayed payment is confirmed but not charged yet, undefined in all other cases.
+         */
+        isDelayedPayment?: boolean;
     };
     /**
      * Information about the monetization which has been bought by this purchase. Monetization definition may change in time so information provided here
@@ -1233,7 +1303,6 @@ export declare type PurchaseEndpointPayload = {
         currency?: Currency;
         /**
          * Frequency in which the user will be charged.
-         * One of "ONE_TIME_PAYMENT", "DAILY", "WEEKLY", "MONTHLY" and "ANNUALLY.
          */
         frequency?: MONETIZATION_FREQUENCY | null;
         /**
@@ -1361,6 +1430,11 @@ export declare interface QerkoCancellationInfo {
 export declare interface QerkoData {
     monetization: PurchasableMonetization;
     item?: Video | TvChannel;
+    /**
+     * If set to true, user is buying voucher.
+     * Otherwise, user is making a purchase for himself.
+     */
+    voucherPurchase?: boolean;
     onPurchase?: () => void;
     onClose?: () => void;
 }
@@ -1369,8 +1443,14 @@ export declare interface QerkoData {
  * @public
  */
 export declare interface QerkoOverlayState {
+    isOpen: boolean;
     data: QerkoData | null;
-    openQerkoOverlay: ((data: QerkoData) => void);
+    /**
+     * Prepares data for
+     * Use this in case when you need to split actions
+     */
+    setData: (data: QerkoData) => void;
+    openQerkoOverlay: (data?: QerkoData) => void;
     closeQerkoOverlay: () => void;
 }
 
@@ -1469,17 +1549,7 @@ export declare interface RouterOverridesContextState {
 /**
  * @public
  */
-export declare interface Row {
-    id: string;
-    rowId: string;
-    name: string;
-    description?: string;
-    itemComponent: RowItemComponent;
-    rowComponent: RowComponent;
-    assets: Assets;
-    type: ScreenRowType;
-    isLiveRow: boolean;
-}
+export declare type Row = RowStandard | RowBanner;
 
 /**
  * @public
@@ -1490,6 +1560,27 @@ export declare enum ROW_ITEM_TYPES {
     TV_CHANNEL = "TV_CHANNEL"
 }
 
+/**
+ * @private
+ */
+export declare interface RowBanner extends RowBase {
+    rowComponent: RowComponent.BANNER;
+    itemComponent: BannerItemComponent;
+}
+
+/**
+ * @private
+ */
+declare interface RowBase {
+    id: string;
+    rowId: string;
+    name: string;
+    description?: string;
+    assets: Assets;
+    type: ScreenRowType;
+    isLiveRow: boolean;
+}
+
 /**
  * @public
  */
@@ -1502,6 +1593,7 @@ export declare enum RowComponent {
  * @public
  */
 export declare interface RowItem extends RowItemAssets {
+    created?: Date;
     itemType: ROW_ITEM_TYPES;
     name?: string;
     description?: string;
@@ -1542,6 +1634,14 @@ export declare type RowItemsSubscription = (rowId: string, cb: (error: Error | n
     hasNextPage: boolean;
 } | null, fetchMore: null | ((count?: number) => void), isLoading: boolean) => void, limit?: number) => Disposer_2;
 
+/**
+ * @private
+ */
+export declare interface RowStandard extends RowBase {
+    rowComponent: RowComponent.ROW;
+    itemComponent: RowItemComponent;
+}
+
 /**
  * @public
  */
@@ -1629,6 +1729,12 @@ export declare interface Section {
     videos: Video[];
 }
 
+export declare enum SemanticDate {
+    YESTERDAY = "Yesterday",
+    TODAY = "Today",
+    TOMORROW = "Tomorrow"
+}
+
 /**
  * Used for entities, that can be global (e.g. asset presets, tag types).
  * Non-global is stored under organizations (in sub-collection), and shown for organization's users and super-admin.
@@ -1748,17 +1854,6 @@ export declare type SubscribeToTaggedVideosOptions = SubscribeToItemsInRowOption
     where?: WhereFilter[];
 };
 
-/**
- * @public
- */
-export declare interface SubscriptionCardProps {
-    subscription: PurchasableMonetization;
-    onClick: (subscription: PurchasableMonetization) => void;
-    buttonLabel: string;
-    purchased: boolean;
-    focused?: boolean;
-}
-
 declare type SubscriptionInfo = {
     type: 'subscription';
     name: string;
@@ -1766,24 +1861,6 @@ declare type SubscriptionInfo = {
     frequency: string;
 };
 
-/**
- * @public
- */
-export declare interface SubscriptionOverlayData {
-    subscriptions?: PurchasableMonetization[];
-    onPurchase?: () => void;
-    onClose?: () => void;
-}
-
-/**
- * @public
- */
-export declare type SubscriptionOverlayState = {
-    data: SubscriptionOverlayData | null;
-    closeSubscriptionOverlay: () => void;
-    openSubscriptionOverlay: (data: SubscriptionOverlayData) => void;
-};
-
 /**
  * @public
  */
@@ -1798,6 +1875,7 @@ export declare interface Tag extends RowItem {
     isFavorite: boolean;
     addToFavorites: () => void;
     removeFromFavorites: () => void;
+    cover: string;
 }
 
 /**
@@ -1831,6 +1909,7 @@ export declare type TileProps = {
      * Now used for backward compatibility for WebTileGrid. Consider to use it other way.
      */
     containerMargin?: number | string;
+    created?: Date;
 };
 
 /**
@@ -2040,7 +2119,7 @@ export declare type TivioInternalBundle = {
  * @public
  */
 export declare type TivioInternalComponents = {
-    PrimaryButton: React_2.ComponentType;
+    PrimaryButton: React_2.ComponentType<any>;
     WebLandingScreen: React_2.ComponentType<{
         logo?: string;
     }>;
@@ -2054,7 +2133,7 @@ export declare type TivioInternalComponents = {
  * @public
  */
 export declare type TivioInternalHooks = {
-    useSubscriptionsOverlay: () => SubscriptionOverlayState;
+    useMonetizationsSelectOverlay: () => MonetizationsSelectOverlayState;
     useQerkoOverlay: () => QerkoOverlayState;
     usePurchasesWithVideos: () => {
         purchases: Purchase[];
@@ -2077,15 +2156,12 @@ export declare type TivioInternalHooks = {
         loading: boolean;
     });
     useTvChannel: UseTvChannel;
-    usePaymentOverlay: () => {
-        videoIdOrUrlName: string | null;
-        setVideoIdOrUrlName: (videoIdOrUrlName: string | null) => void;
-    };
     useChannelSource: UseChannelSource;
     useUser: () => {
         user: User | null;
         error: string | null;
         isInitialized: boolean;
+        isSignedIn: boolean;
     };
 };
 
@@ -2101,10 +2177,9 @@ export declare type TivioInternalProviders = {
     }>;
     ConfigProvider: React_2.ComponentType;
     UserContextProvider: React_2.ComponentType;
-    SubscriptionOverlayContextProvider: React_2.ComponentType;
+    MonetizationsSelectOverlayContextProvider: 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
      */
@@ -2341,8 +2416,14 @@ export declare interface TvChannel extends RowItem {
     logo?: string;
     hls: string;
     dash: string;
+    /**
+     * Returns all transactions and subscriptions applied to this tv channel.
+     * Transactions before subscriptions, sorted by price ascending.
+     */
+    getPurchasableMonetizations(options?: GetPurchasableMonetizationsOptions): PurchasableMonetization[];
     purchasableMonetization: any | null;
     price: number;
+    cover: string;
 }
 
 /**
@@ -2552,6 +2633,10 @@ export declare type User = {
      * Returns "active" (non-expired) subscription purchases
      */
     purchasedSubscriptions: Purchase[];
+    /**
+     * Returns last expired subscription which user can renew or undefined
+     */
+    extendableSubscription?: Purchase;
     isPurchasesInitialized: boolean;
     isSignedIn: boolean;
     email?: string;
@@ -2587,7 +2672,7 @@ export declare enum UserType {
 /**
  * @public
  */
-export declare type UseSearch = <T extends ALGOLIA_INDEX_NAME>(indexName: T, options?: UseSearchOptions) => {
+export declare type UseSearch = <T extends ALGOLIA_INDEX_NAME>(indexName: T, options?: UseSearchOptions<T>) => {
     search: (query: string) => void;
     pagination: Omit<PaginationInterface<UseSearchResult<T>>, 'loading'> | null;
     error: Error | null;
@@ -2606,15 +2691,26 @@ export declare const useSearch: UseSearch;
 /**
  * @public
  */
-export declare type UseSearchOptions = PaginationOptions & Partial<{
-    minQueryLength: number;
-}>;
+export declare type UseSearchOptions<T extends ALGOLIA_INDEX_NAME = any> = PaginationOptions & {
+    minQueryLength?: number;
+} & (T extends ALGOLIA_INDEX_NAME.VIDEOS ? UseSearchVideoOptions : {});
 
 /**
  * @public
  */
 export 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;
 
+/**
+ * @public
+ */
+export declare type UseSearchVideoOptions = {
+    /**
+     * If true video tags are awaited before loading is over.
+     * Otherwise, only videos are awaited.
+     */
+    waitForTags?: boolean;
+};
+
 /**
  * @public
  */
@@ -2662,6 +2758,7 @@ export declare const useUser: () => {
     user: User | null;
     error: string | null;
     isInitialized: boolean;
+    isSignedIn: boolean;
 };
 
 /**
@@ -2731,7 +2828,10 @@ export declare enum VastProvider {
     MALL_TV_PREBID = "malltv-prebid",
     PRIMA = "prima",
     TEST = "test",
-    TEST_VPAID = "test-vpaid"
+    TEST_VPAID = "test-vpaid",
+    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"
 }
 
 /**
@@ -2743,7 +2843,6 @@ export declare interface Video extends RowItem {
      * @deprecated use assets instead
      */
     cover: string | null;
-    created: Date;
     sectionId: string | null;
     channelId: string | null;
     /**
@@ -2755,11 +2854,15 @@ export declare interface Video extends RowItem {
     image: string | null;
     isPlayable: boolean;
     monetizations: Monetization[];
-    transactionId?: string;
-    sources?: any[];
+    /**
+     * Returns all transactions and subscriptions applied to this video.
+     * Transactions before subscriptions, sorted by price ascending.
+     */
+    getPurchasableMonetizations(options?: GetPurchasableMonetizationsOptions): PurchasableMonetization[];
+    purchasableMonetization: any | null;
     transaction: PurchasableMonetization | undefined;
     subscriptions: PurchasableMonetization[];
-    subscriptionIds: string[];
+    sources?: any[];
     isPlaylist: boolean;
     name: string;
     urlNames?: string[];
@@ -2774,7 +2877,6 @@ export declare interface Video extends RowItem {
     detailBanner?: string;
     linkedVideosRaw: any[];
     linkedVideos: LinkedVideo[];
-    purchasableMonetization: any | null;
     contentType: VideoContentType | null;
     year?: number;
     episodeNumber?: number;
@@ -2831,6 +2933,14 @@ export declare enum VideoType {
      * Video is a standard single video.
      */
     VIDEO = "VIDEO",
+    /**
+     * Part of video original video like CUT.
+     */
+    CUT = "CUT",
+    /**
+     * Part of video original video like TRAILER.
+     */
+    TRAILER = "TRAILER",
     TV_PROGRAM = "TV_PROGRAM",
     /**
      * Video object represents whole series, e.g. tv show.