@tivio/sdk-react 4.4.0 → 4.5.0

package/README.md

@@ -6,6 +6,12 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* v4.5.0
+  * minor: extend PurchaseEndpointPayload type with purchase previousStatus and newStatus fields
+
+* 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

package/README.md.bak

@@ -6,6 +6,12 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* v4.5.0
+  * minor: extend PurchaseEndpointPayload type with purchase previousStatus and newStatus fields
+
+* 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

package/dist/index.d.ts

@@ -209,6 +209,7 @@ export declare type BannerProps = {
     borderRadius?: string | number;
     buttonText?: string;
     onButtonClick?: () => void;
+    numberOfLines?: number;
 };
 
 /**
@@ -299,6 +300,36 @@ export declare type CmpConfig = 'default' | 'debug' | 'none';
  */
 export declare type Config = SdkReactConfig;
 
+/**
+ * @public
+ */
+export declare interface ConfirmationOverlayContextState {
+    isOpen: boolean;
+    payload: ConfirmationOverlayPayload | null;
+    closeOverlay: () => void;
+    openOverlay: (payload: ConfirmationOverlayPayload) => void;
+    confirmAction: () => void;
+}
+
+/**
+ * @public
+ */
+export declare type ConfirmationOverlayPayload = SuccessConfirmationOverlayPayload | WarningConfirmationOverlayPayload;
+
+/**
+ * @public
+ */
+export declare interface ConfirmationOverlayPayloadBase {
+    title?: string;
+    caption?: string;
+    onClose?: () => void;
+    onConfirm?: () => void;
+    /**
+     * If configured, then overlay is automatically confirmed after this time.
+     */
+    automaticConfirmDelayMs?: number;
+}
+
 /**
  * @public
  * @TODO move somewhere else
@@ -544,9 +575,10 @@ export declare interface IndexedUser extends IndexedObject {
  * @public
  */
 export declare interface IndexedVideo extends IndexedObject {
-    organizationPath?: string;
+    assets: any;
+    organizationPath: string;
     tagPaths?: string[];
-    created: Date;
+    created: Date | string;
     isDraft: boolean;
     type: VideoType;
     contentType?: VideoContentType;
@@ -727,6 +759,11 @@ declare interface Logger {
  */
 declare type LoggerArgs = any[];
 
+export declare enum LoginRedirect {
+    PAYMENT = "payment",
+    VOUCHER = "voucher"
+}
+
 /**
  * @public
  */
@@ -780,6 +817,14 @@ export declare enum MONETIZATION_FREQUENCY {
     ANNUALLY = "ANNUALLY"
 }
 
+/**
+ * @public
+ */
+export declare interface MonetizationActions {
+    selectMonetization: (monetization: PurchasableMonetization) => void;
+    errors: string[];
+}
+
 /**
  * @public
  */
@@ -878,6 +923,7 @@ declare type OrderByDirection = 'desc' | 'asc';
  * @public
  */
 export declare interface Organization {
+    userProfileConfiguration: any;
 }
 
 /**
@@ -1291,6 +1337,14 @@ export declare type PurchaseEndpointPayload = {
          * True if delayed payment is confirmed but not charged yet, undefined in all other cases.
          */
         isDelayedPayment?: boolean;
+        /**
+         * Purchase status before change.
+         */
+        previousStatus: PurchaseStatus;
+        /**
+         * Purchase status after change.
+         */
+        newStatus: PurchaseStatus;
     };
     /**
      * Information about the monetization which has been bought by this purchase. Monetization definition may change in time so information provided here
@@ -1528,15 +1582,27 @@ export declare type RemoteProviderProps = {
  * @public
  */
 export declare interface RouterOverrides {
+    getVideoDetailPath: (videoIdOrUrlName: string) => string;
+    getSeriesDetailPath: (tagId: string) => string;
+    getTagPath: (tagId: string) => string;
+    getLoginPath: () => string;
+    getRegistrationPath: () => string;
+    getLivePlayerPath: (tvChannelId: string) => string;
+    getVodPlayerPath: (videoIdOrUrlName: string) => string;
+    getHomePath: (screens: ScreenConfig[]) => string;
     goToVideoDetailPage: (videoIdOrUrlName: string) => void;
     goToSeriesDetailPage: (tagId: string) => void;
     goToTagPage: (tagId: string) => void;
-    goToLoginPage: () => void;
+    goToLoginPage: (options?: {
+        manual?: boolean;
+        origin?: LoginRedirect;
+    }) => void;
     goToRegistrationPage: () => void;
     goBack: () => void;
     goLivePlayer: (tvChannelId: string) => void;
     goVodPlayer: (videoIdOrUrlName: string) => void;
-    goToHome: () => void;
+    goToHome: (user?: any, activeUserProfileId?: string) => void;
+    goToRoute: (route: string) => void;
 }
 
 /**
@@ -1544,6 +1610,9 @@ export declare interface RouterOverrides {
  */
 export declare interface RouterOverridesContextState {
     routerOverrides: RouterOverrides;
+    Link: React_2.ComponentType<{
+        href?: string;
+    }>;
 }
 
 /**
@@ -1579,6 +1648,7 @@ declare interface RowBase {
     assets: Assets;
     type: ScreenRowType;
     isLiveRow: boolean;
+    numberOfLines?: number;
 }
 
 /**
@@ -1674,6 +1744,11 @@ export { Screen_2 as Screen }
 export declare type ScreenConfig = {
     id: string;
     name: string;
+    route?: string;
+    showForUserProfileType?: {
+        kids: boolean;
+        adults: boolean;
+    };
 };
 
 /**
@@ -1861,11 +1936,20 @@ declare type SubscriptionInfo = {
     frequency: string;
 };
 
+/**
+ * @public
+ */
+export declare interface SuccessConfirmationOverlayPayload extends ConfirmationOverlayPayloadBase {
+    type: 'success';
+    confirmButtonText?: string;
+}
+
 /**
  * @public
  */
 export declare interface Tag extends RowItem {
     id: string;
+    itemType: ROW_ITEM_TYPES.TAG;
     tagId: string;
     type?: string | null;
     metadata?: any[];
@@ -1890,7 +1974,6 @@ export declare type TileProps = {
     cover: string;
     bottomLabel: string;
     bottomLabelAreaHeight: number;
-    bottomLabelTextLinesCount: number;
     innerLabel: string;
     duration: string;
     price: string | null;
@@ -1910,6 +1993,7 @@ export declare type TileProps = {
      */
     containerMargin?: number | string;
     created?: Date;
+    numberOfLines?: number;
 };
 
 /**
@@ -2013,7 +2097,8 @@ export declare interface TivioConfig {
     language: LangCode;
     debug?: boolean;
     verbose?: boolean;
-    firebaseApp?: any;
+    firebaseApp?: any | null;
+    firestore?: any | null;
     currency: Currency;
     /**
      * Configuration for GDPR consent collection (CMP)
@@ -2127,6 +2212,10 @@ export declare type TivioInternalComponents = {
         videoIdOrUrlName: string;
     }>;
     WebSeriesDetailScreen: React_2.ComponentType<WebSeriesDetailScreenProps>;
+    WebConfirmationOverlay: React_2.ComponentType;
+    UserProfilesOverlay: React_2.ComponentType<{
+        onClose: (selectedProfileId: string) => void;
+    }>;
 };
 
 /**
@@ -2135,6 +2224,9 @@ export declare type TivioInternalComponents = {
 export declare type TivioInternalHooks = {
     useMonetizationsSelectOverlay: () => MonetizationsSelectOverlayState;
     useQerkoOverlay: () => QerkoOverlayState;
+    useConfirmationOverlay: () => ConfirmationOverlayContextState;
+    useMonetizationActions: () => MonetizationActions;
+    useCancelSubscriptions: () => UseCancelSubscriptionsResult;
     usePurchasesWithVideos: () => {
         purchases: Purchase[];
     };
@@ -2163,6 +2255,7 @@ export declare type TivioInternalHooks = {
         isInitialized: boolean;
         isSignedIn: boolean;
     };
+    useOrganization: () => Organization | null;
 };
 
 /**
@@ -2184,7 +2277,10 @@ export declare type TivioInternalProviders = {
      * @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>;
+    RouterOverridesContextProvider: React_2.ComponentType<{
+        state: RouterOverridesContextState;
+    }>;
+    ConfirmationOverlayContextProvider: React_2.ComponentType;
 };
 
 /**
@@ -2407,10 +2503,10 @@ export declare type TvAppProps = {
  * @public
  */
 export declare interface TvChannel extends RowItem {
-    name: string;
     id: string;
+    itemType: ROW_ITEM_TYPES.TV_CHANNEL;
+    name: string;
     path: string;
-    itemType: ROW_ITEM_TYPES;
     country?: string;
     filters: string[];
     logo?: string;
@@ -2424,6 +2520,7 @@ export declare interface TvChannel extends RowItem {
     purchasableMonetization: any | null;
     price: number;
     cover: string;
+    isPlayable: boolean;
 }
 
 /**
@@ -2517,6 +2614,15 @@ export declare type UseCancelSubscription = (subscriptionId: string) => {
  */
 export declare const useCancelSubscription: UseCancelSubscription;
 
+/**
+ * @public
+ */
+export declare interface UseCancelSubscriptionsResult {
+    cancelSubscriptions: (subscriptionIds: string[]) => Promise<void>;
+    cancellationInfos: QerkoCancellationInfo[];
+    errors: string[];
+}
+
 /**
  * @public
  */
@@ -2633,8 +2739,13 @@ 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;
+    isReady: boolean;
     email?: string;
     type?: UserType;
     photoURL: string | null;
@@ -2642,6 +2753,10 @@ export declare type User = {
     authUserId?: string;
     favorites: any[];
     watchedPositions: any[];
+    profiles: any[];
+    activeUserProfileId: string | null;
+    createUserProfile: (request: any) => Promise<void>;
+    setActiveUserProfileId: (id: string) => void;
 };
 
 /**
@@ -2668,7 +2783,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;
@@ -2687,14 +2802,25 @@ 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 | ALGOLIA_INDEX_NAME.VIDEOSDESC ? UseSearchVideoOptions : {});
+
+/**
+ * @public
+ */
+export declare type UseSearchResult<T extends ALGOLIA_INDEX_NAME> = T extends ALGOLIA_INDEX_NAME.VIDEOS | ALGOLIA_INDEX_NAME.VIDEOSDESC ? Video : T extends ALGOLIA_INDEX_NAME.TAGS ? Tag : T extends ALGOLIA_INDEX_NAME.TV_CHANNELS ? TvChannel : unknown;
 
 /**
  * @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;
+export declare type UseSearchVideoOptions = {
+    /**
+     * If true video tags are awaited before loading is over.
+     * Otherwise, only videos are awaited.
+     */
+    waitForTags?: boolean;
+};
 
 /**
  * @public
@@ -2824,6 +2950,7 @@ export declare enum VastProvider {
  */
 export declare interface Video extends RowItem {
     id: string;
+    itemType: ROW_ITEM_TYPES.VIDEO;
     /**
      * @deprecated use assets instead
      */
@@ -2984,6 +3111,15 @@ declare type Voucher = {
     voucherInfo: SubscriptionInfo | TransactionInfo;
 };
 
+/**
+ * @public
+ */
+export declare interface WarningConfirmationOverlayPayload extends ConfirmationOverlayPayloadBase {
+    type: 'warning';
+    confirmButtonText?: string;
+    closeButtonText?: string;
+}
+
 /**
  * @public
  */