@tivio/sdk-react 7.1.0 → 7.2.0-alpha.1

package/README.md

@@ -6,6 +6,10 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* UNRELEASED
+    * major: deprecated usePurchasesWithVideos hook removed
+    * patch: add id to user type
+
 * 7.1.0
     * minor: export useTvChannelHook
     * patch: bump "react-i18next", "i18next" versions.

package/README.md.bak

@@ -6,6 +6,10 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* UNRELEASED
+    * major: deprecated usePurchasesWithVideos hook removed
+    * patch: add id to user type
+
 * 7.1.0
     * minor: export useTvChannelHook
     * patch: bump "react-i18next", "i18next" versions.

package/dist/index.d.ts

@@ -336,6 +336,14 @@ export declare type Assets = {
     [assetName: string]: ScalableAsset;
 };
 
+declare type Attributes = {
+    created: string;
+    email: string;
+    full_name: string;
+    url: string;
+    image_url: string;
+};
+
 /**
  * @public
  */
@@ -363,7 +371,8 @@ export declare type BadRequestError = Error & {
 
 export declare enum BannerItemComponent {
     CLASSIC = "CLASSIC",
-    SPLIT = "SPLIT"
+    SPLIT = "SPLIT",
+    BACKGROUND = "BACKGROUND"
 }
 
 /**
@@ -372,6 +381,7 @@ export declare enum BannerItemComponent {
 export declare type BannerProps = {
     isLoading: boolean;
     text: string;
+    description?: string;
     focused: boolean;
     onClick?: () => void;
     hoverable: boolean;
@@ -382,6 +392,7 @@ export declare type BannerProps = {
     borderRadius?: string | number;
     buttonText?: string;
     onButtonClick?: () => void;
+    buttonHref?: string;
     numberOfLines?: number;
 };
 
@@ -721,21 +732,25 @@ export declare type Currency = 'CZK' | 'EUR' | 'USD';
  * @public
  */
 export declare enum CustomerId {
-    OKTAGON = "OKTAGON",
-    JOJ = "JOJ",
-    MALL = "MALL",
-    GARAZ = "GARAZ",
-    U_KULATEHO_STOLU = "U_KULATEHO_STOLU",
-    INVESTOREES = "INVESTOREES",
+    CNC = "CNC",
     DVTV = "DVTV",
     DVTV_DEV = "DVTV_DEV",
-    O2 = "O2",
+    GARAZ = "GARAZ",
     GRAPE = "GRAPE",
-    TIVIO = "TIVIO",
-    STORYBOOK = "STORYBOOK",
+    HODINA_DEJEPICHU = "HODINA_DEJEPICHU",
+    INVESTICNI_PRUVODCE = "INVESTICNI_PRUVODCE",
+    INVESTOREES = "INVESTOREES",
+    JOJ = "JOJ",
+    MALL = "MALL",
+    MEDIAR = "MEDIAR",
     NANGU_DEV = "NANGU_DEV",
-    CNC = "CNC",
-    VOJTA_ZIZKA = "VOJTA_ZIZKA"
+    O2 = "O2",
+    OKTAGON = "OKTAGON",
+    ONDREJ_KOBERSKY = "ONDREJ_KOBERSKY",
+    STARMAX = "STARMAX",
+    STORYBOOK = "STORYBOOK",
+    TIVIO = "TIVIO",
+    U_KULATEHO_STOLU = "U_KULATEHO_STOLU"
 }
 
 /**
@@ -746,6 +761,13 @@ export declare interface Cutout {
     endMs: number;
 }
 
+declare type Data = {
+    attributes: Attributes;
+    id: string;
+    relationships: Relationship;
+    type: 'tier' | 'member' | 'user';
+};
+
 /**
  * @public
  */
@@ -932,7 +954,7 @@ export declare interface EmailTemplateVersion {
 
 export declare type EmbedScreenMessageNavigateType = {
     type: EmbedScreenMessageType.NAVIGATE;
-    to: string | 'Profile' | 'Home' | 'Search' | 'Video' | 'Series';
+    to: string | 'Profile' | 'Home' | 'Search' | 'Video' | 'Series' | 'Subscription';
     value?: string;
 };
 
@@ -1208,6 +1230,24 @@ export declare enum GRID_TYPES {
     SERIES = "SERIES"
 }
 
+declare type IncludedItem = {
+    attributes: {
+        next_charge_date: string;
+        /**
+         * A null value indicates the member has never pledged. Can be null.
+         */
+        patron_status: 'active_patron' | 'declined_patron' | 'former_patron' | null;
+        /**
+         * The only successful status is Paid. null if never charged. Can be null.
+         * One of Paid Declined Deleted Pending Refunded Fraud Other.
+         */
+        last_charge_status: 'Paid' | 'Declined' | 'Deleted' | 'Pending' | 'Refunded' | 'Fraud' | 'Other';
+        last_charge_date: string;
+    };
+    id: string;
+    type: string;
+};
+
 /**
  * @public
  */
@@ -1404,6 +1444,10 @@ export declare type LinkedVideo = {
     type: 'CUT' | 'TRAILER' | 'BONUS' | 'CHILD';
 };
 
+declare type Links = {
+    self: string;
+};
+
 /**
  * @public
  */
@@ -1536,6 +1580,11 @@ export declare type MarkersProps = {
     className?: string;
 };
 
+declare type Membership = {
+    id: string;
+    type: string;
+};
+
 /**
  * External information of video migrated via our Public API.
  * @public
@@ -1781,6 +1830,37 @@ export declare type PaginationOptions = Partial<{
     noAutoFetch: boolean;
 }>;
 
+export declare type PatreonCreatorData = {
+    campaign: string;
+    tiers: Tier[];
+};
+
+declare type PatreonError = {
+    challenge_metadata?: string | null;
+    code?: number;
+    code_name?: string;
+    detail?: string;
+    id: string;
+    status: string;
+    title?: string;
+};
+
+export declare type PatreonUserAuth = {
+    access_token: string;
+    refresh_token: string;
+    expires_in: number;
+    token_type?: string;
+    scope?: string;
+    version?: string;
+};
+
+export declare type PatreonUserResponse = {
+    data: Data;
+    included: IncludedItem[];
+    links: Links;
+    errors?: PatreonError[];
+};
+
 /**
  * @public
  */
@@ -1881,11 +1961,11 @@ export declare type PlayerConfig = {
      */
     adService?: {
         /**
-         * Tivio - can be used in websites and TV apps. Does not support VPAID
+         * TIVIO AD SERVICE - can be used in websites and TV apps. Does not support VPAID
          * IMA - can be used only in websites. Supports VAST 2, partially VAST 3, VAST 4, SIMID 1.0, OM SDK 1.3,
          *   VPAID 2 (HTML5) https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/compatibility
          */
-        name: 'IMA SDK' | 'Tivio';
+        name: 'IMA SDK' | 'TIVIO AD SERVICE';
     };
 };
 
@@ -2005,6 +2085,11 @@ export declare interface PlayerEngineInterface {
     destroy(): Promise<void>;
     getBufferedInfo?(): BufferChunk[];
     lastQuality: number | null;
+    /**
+     * Attribute indicating that the video is to be played "inline"
+     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#playsinline
+     */
+    setPlaysInline(value: boolean): void;
 }
 
 /**
@@ -2079,6 +2164,11 @@ export declare interface PlayerInterface {
      */
     getNativeImaAdUrl?: () => string | null;
     lastQuality?: number | null;
+    /**
+     * Attribute indicating that the video is to be played "inline"
+     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#playsinline
+     */
+    setPlaysInline?: (value: boolean) => void;
 }
 
 /**
@@ -2338,10 +2428,9 @@ export declare type Purchase = {
      * Timestamp of the last purchase status update in milliseconds.
      */
     updated: number | null;
-    video: Video | null;
     videoId: string | null;
     videoRef: any | null;
-    voucherId?: string;
+    voucherId: string | null;
 };
 
 /**
@@ -2352,7 +2441,8 @@ export declare enum PurchaseDocumentGateway {
     'oktagon' = "oktagon",
     'voucher' = "voucher",
     'comgate' = "comgate",
-    'tivio' = "tivio"
+    'tivio' = "tivio",
+    'patreon' = "patreon"
 }
 
 /**
@@ -2495,14 +2585,14 @@ export declare type PurchaseMonetization = {
     period?: number;
     price?: number;
     /**
-     * Here are only transaction and subscription, because purchasing of advertisement monetization doesn't make sense.
+     * Here are only transaction and subscription because purchasing of advertisement monetization doesn't make sense.
      */
     type: 'transaction' | 'subscription';
     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.
+     * 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;
 };
@@ -2522,7 +2612,7 @@ export declare enum PurchaseStatus {
 }
 
 /**
- * Purchase is a purchase of one video (transaction type), purchase of subscription or voucher.
+ * Purchase is a purchase of one video (transaction type) purchase of subscription or voucher.
  *
  * @public
  */
@@ -2623,6 +2713,12 @@ export declare enum RegistrationRedirect {
     PAYMENT = "payment"
 }
 
+declare type Relationship = {
+    memberships: {
+        data: Membership[];
+    };
+};
+
 /**
  * @public
  */
@@ -2641,6 +2737,24 @@ export declare type RemoteProviderProps = {
     children: React_2.ReactNode;
 };
 
+/**
+ * Conditions that are dynamically applied to screens before they are rendered.
+ * eg. when we want to render an embed only if certain conditions are met.
+ * 'type' indicates type of the condition, eg. 'subscribed'.
+ * 'else' indicates what should happen if the conditions are not met.
+ * 'elseValue' is a payload.
+ */
+export declare type RenderCondition = {
+    type: ScreenConditionType;
+    else: ScreenConditionElse;
+    elseValue: RenderConditionElseValue[];
+};
+
+export declare type RenderConditionElseValue = {
+    key: string;
+    value: string;
+};
+
 /**
  * @public
  */
@@ -2858,6 +2972,14 @@ declare interface Screen_2 {
 }
 export { Screen_2 as Screen }
 
+export declare enum ScreenConditionElse {
+    SET_QUERY_PARAMS = "setQueryParams"
+}
+
+export declare enum ScreenConditionType {
+    SUBSCRIBED = "subscribed"
+}
+
 /**
  * @public
  */
@@ -3124,6 +3246,19 @@ export declare interface Tag extends RowItem {
  */
 export declare type TaggedVideosOrderByField = 'seasonNumber' | 'episodeNumber' | 'contentType' | DefaultOrderByField;
 
+export declare type Tier = {
+    attributes: {
+        amount_cents: number;
+        description: string;
+        image_url: string | null;
+        patron_count: number;
+        title: string;
+        url: string;
+    };
+    id: string;
+    type: 'tier';
+};
+
 /**
  * @public
  */
@@ -3408,9 +3543,6 @@ export declare type TivioInternalHooks = {
     useConfirmationOverlay: () => ConfirmationOverlayContextState;
     useMonetizationActions: () => MonetizationActions;
     useCancelSubscriptions: () => UseCancelSubscriptionsResult;
-    usePurchasesWithVideos: () => {
-        purchases: Purchase[];
-    };
     useEpisodes: (seriesTagId: string | null | undefined, seasonNumber: number | null, options: UseEpisodesQueryOptions) => UseEpisodesResult;
     useVideosInScreen: (filters: RowFilterField) => {
         pagination: PaginationInterface<Video> | null;
@@ -4030,21 +4162,17 @@ export declare function usePurchaseRecovery(): {
  */
 export declare const usePurchaseSubscription: (monetizationId: string, voucher?: NewVoucher) => QerkoTransaction;
 
-/**
- * Return purchases with initialized video (purchases[i].video not null)
- * @public
- */
-export declare const usePurchasesWithVideos: () => {
-    purchases: Purchase[];
-};
-
 /**
  * @public
  */
 export declare type User = {
     /**
-     * Returns "active" (non-expired) purchases, so they give access to some content.
-     * Does not return voucher purchases, because they give access to videos/subscriptions only for user who activates voucher,
+     * Unique id of the corresponding user document.
+     */
+    id: string;
+    /**
+     * Returns "active" (non-expired) purchases so they give access to some content.
+     * Does not return voucher purchases because they give access to videos/subscriptions only for user who activates voucher
      * not for user who purchases it.
      */
     purchases: Purchase[];
@@ -4064,6 +4192,7 @@ export declare type User = {
      * Returns last expired subscription which user can renew or undefined
      */
     extendableSubscription?: Purchase;
+    getPurchasedVideos: () => Video[];
     isPurchasesInitialized: boolean;
     isSignedIn: boolean;
     isReady: boolean;
@@ -4071,11 +4200,15 @@ export declare type User = {
     type?: UserType;
     photoURL: string | null;
     name?: string;
+    /**
+     * Authentication id differs from {@link id}.
+     */
     authUserId?: string;
     favorites: any[];
     watchedPositions: any[];
     profiles: any[];
     activeUserProfileId: string | null;
+    patreon?: PatreonUserAuth;
     createUserProfile: (request: any) => Promise<void>;
     deleteUserProfile: (profileId: string) => Promise<void>;
     setActiveUserProfileId: (id: string) => void;
@@ -4270,7 +4403,8 @@ export declare enum VastProvider {
     GARAZ_TV = "garaz.tv",
     GARAZ_TV_DEV = "garaz.tv.dev",
     IMPRESSION_MEDIA_PREBID = "impressionMedia-prebid",
-    JOJ = "joj",
+    JOJ_ADFORM = "joj",
+    JOJ_SMART = "joj-smart",
     JOJ_AD_MANAGER_VOD_PREROLL = "joj-ad-manager-vod-preroll",
     JOJ_AD_MANAGER_VOD_MIDROLL = "joj-ad-manager-vod-midroll",
     JOJ_AD_MANAGER_LIVE_PREROLL = "joj-ad-manager-live-preroll",